Options
All
  • Public
  • Public/Protected
  • All
Menu

@azure/storage-blob

Index

Enumerations

Classes

Interfaces

Type aliases

Variables

Functions

Object literals

Type aliases

AccessTier

AccessTier: "P4" | "P6" | "P10" | "P15" | "P20" | "P30" | "P40" | "P50" | "P60" | "P70" | "P80" | "Hot" | "Cool" | "Archive"

Defines values for AccessTier. Possible values include: 'P4', 'P6', 'P10', 'P15', 'P20', 'P30', 'P40', 'P50', 'P60', 'P70', 'P80', 'Hot', 'Cool', 'Archive'

readonly
enum

{string}

AccountKind

AccountKind: "Storage" | "BlobStorage" | "StorageV2"

Defines values for AccountKind. Possible values include: 'Storage', 'BlobStorage', 'StorageV2'

readonly
enum

{string}

AppendBlobAppendBlockFromUrlResponse

AppendBlobAppendBlockFromUrlResponse: AppendBlobAppendBlockFromUrlHeaders & object

Contains response data for the appendBlockFromUrl operation.

AppendBlobAppendBlockResponse

AppendBlobAppendBlockResponse: AppendBlobAppendBlockHeaders & object

Contains response data for the appendBlock operation.

AppendBlobCreateResponse

AppendBlobCreateResponse: AppendBlobCreateHeaders & object

Contains response data for the create operation.

ArchiveStatus

ArchiveStatus: "rehydrate-pending-to-hot" | "rehydrate-pending-to-cool"

Defines values for ArchiveStatus. Possible values include: 'rehydrate-pending-to-hot', 'rehydrate-pending-to-cool'

readonly
enum

{string}

BlobAbortCopyFromURLResponse

BlobAbortCopyFromURLResponse: BlobAbortCopyFromURLHeaders & object

Contains response data for the abortCopyFromURL operation.

BlobAcquireLeaseResponse

BlobAcquireLeaseResponse: BlobAcquireLeaseHeaders & object

Contains response data for the acquireLease operation.

BlobBreakLeaseResponse

BlobBreakLeaseResponse: BlobBreakLeaseHeaders & object

Contains response data for the breakLease operation.

BlobChangeLeaseResponse

BlobChangeLeaseResponse: BlobChangeLeaseHeaders & object

Contains response data for the changeLease operation.

BlobCopyFromURLResponse

BlobCopyFromURLResponse: BlobCopyFromURLHeaders & object

Contains response data for the copyFromURL operation.

BlobCreateSnapshotResponse

BlobCreateSnapshotResponse: BlobCreateSnapshotHeaders & object

Contains response data for the createSnapshot operation.

BlobDeleteResponse

BlobDeleteResponse: BlobDeleteHeaders & object

Contains response data for the deleteMethod operation.

BlobGetAccessControlResponse

BlobGetAccessControlResponse: BlobGetAccessControlHeaders & object

Contains response data for the getAccessControl operation.

BlobGetAccountInfoResponse

BlobGetAccountInfoResponse: BlobGetAccountInfoHeaders & object

Contains response data for the getAccountInfo operation.

BlobGetPropertiesResponse

BlobGetPropertiesResponse: BlobGetPropertiesHeaders & object

Contains response data for the getProperties operation.

BlobReleaseLeaseResponse

BlobReleaseLeaseResponse: BlobReleaseLeaseHeaders & object

Contains response data for the releaseLease operation.

BlobRenameResponse

BlobRenameResponse: BlobRenameHeaders & object

Contains response data for the rename operation.

BlobRenewLeaseResponse

BlobRenewLeaseResponse: BlobRenewLeaseHeaders & object

Contains response data for the renewLease operation.

BlobSetAccessControlResponse

BlobSetAccessControlResponse: BlobSetAccessControlHeaders & object

Contains response data for the setAccessControl operation.

BlobSetHTTPHeadersResponse

BlobSetHTTPHeadersResponse: BlobSetHTTPHeadersHeaders & object

Contains response data for the setHTTPHeaders operation.

BlobSetMetadataResponse

BlobSetMetadataResponse: BlobSetMetadataHeaders & object

Contains response data for the setMetadata operation.

BlobSetTierResponse

BlobSetTierResponse: BlobSetTierHeaders & object

Contains response data for the setTier operation.

BlobStartCopyFromURLResponse

BlobStartCopyFromURLResponse: BlobStartCopyFromURLHeaders & object

Contains response data for the startCopyFromURL operation.

BlobType

BlobType: "BlockBlob" | "PageBlob" | "AppendBlob"

Defines values for BlobType. Possible values include: 'BlockBlob', 'PageBlob', 'AppendBlob'

readonly
enum

{string}

BlobUndeleteResponse

BlobUndeleteResponse: BlobUndeleteHeaders & object

Contains response data for the undelete operation.

BlobUploadCommonResponse

BlobUploadCommonResponse: BlockBlobUploadHeaders & object

Type for uploadFileToBlockBlob, uploadStreamToBlockBlob and uploadBrowserDateToBlockBlob.

export

BlockBlobCommitBlockListResponse

BlockBlobCommitBlockListResponse: BlockBlobCommitBlockListHeaders & object

Contains response data for the commitBlockList operation.

BlockBlobGetBlockListResponse

BlockBlobGetBlockListResponse: BlockList & BlockBlobGetBlockListHeaders & object

Contains response data for the getBlockList operation.

BlockBlobStageBlockFromURLResponse

BlockBlobStageBlockFromURLResponse: BlockBlobStageBlockFromURLHeaders & object

Contains response data for the stageBlockFromURL operation.

BlockBlobStageBlockResponse

BlockBlobStageBlockResponse: BlockBlobStageBlockHeaders & object

Contains response data for the stageBlock operation.

BlockBlobUploadResponse

BlockBlobUploadResponse: BlockBlobUploadHeaders & object

Contains response data for the upload operation.

BlockListType

BlockListType: "committed" | "uncommitted" | "all"

Defines values for BlockListType. Possible values include: 'committed', 'uncommitted', 'all'

readonly
enum

{string}

ContainerAcquireLeaseResponse

ContainerAcquireLeaseResponse: ContainerAcquireLeaseHeaders & object

Contains response data for the acquireLease operation.

ContainerBreakLeaseResponse

ContainerBreakLeaseResponse: ContainerBreakLeaseHeaders & object

Contains response data for the breakLease operation.

ContainerChangeLeaseResponse

ContainerChangeLeaseResponse: ContainerChangeLeaseHeaders & object

Contains response data for the changeLease operation.

ContainerCreateResponse

ContainerCreateResponse: ContainerCreateHeaders & object

Contains response data for the create operation.

ContainerDeleteResponse

ContainerDeleteResponse: ContainerDeleteHeaders & object

Contains response data for the deleteMethod operation.

ContainerGetAccessPolicyResponse

ContainerGetAccessPolicyResponse: object & ContainerGetAccessPolicyHeaders & object

Contains response data for the getAccessPolicy operation.

ContainerGetAccountInfoResponse

ContainerGetAccountInfoResponse: ContainerGetAccountInfoHeaders & object

Contains response data for the getAccountInfo operation.

ContainerGetPropertiesResponse

ContainerGetPropertiesResponse: ContainerGetPropertiesHeaders & object

Contains response data for the getProperties operation.

ContainerListBlobFlatSegmentResponse

ContainerListBlobFlatSegmentResponse: ListBlobsFlatSegmentResponse & ContainerListBlobFlatSegmentHeaders & object

Contains response data for the listBlobFlatSegment operation.

ContainerListBlobHierarchySegmentResponse

ContainerListBlobHierarchySegmentResponse: ListBlobsHierarchySegmentResponse & ContainerListBlobHierarchySegmentHeaders & object

Contains response data for the listBlobHierarchySegment operation.

ContainerReleaseLeaseResponse

ContainerReleaseLeaseResponse: ContainerReleaseLeaseHeaders & object

Contains response data for the releaseLease operation.

ContainerRenewLeaseResponse

ContainerRenewLeaseResponse: ContainerRenewLeaseHeaders & object

Contains response data for the renewLease operation.

ContainerSetAccessPolicyResponse

ContainerSetAccessPolicyResponse: ContainerSetAccessPolicyHeaders & object

Contains response data for the setAccessPolicy operation.

ContainerSetMetadataResponse

ContainerSetMetadataResponse: ContainerSetMetadataHeaders & object

Contains response data for the setMetadata operation.

CopyStatusType

CopyStatusType: "pending" | "success" | "aborted" | "failed"

Defines values for CopyStatusType. Possible values include: 'pending', 'success', 'aborted', 'failed'

readonly
enum

{string}

CredentialPolicyCreator

CredentialPolicyCreator: function

A factory function that creates a new CredentialPolicy that uses the provided nextPolicy.

Type declaration

    • Parameters

      • nextPolicy: RequestPolicy
      • options: RequestPolicyOptions

      Returns CredentialPolicy

DeleteSnapshotsOptionType

DeleteSnapshotsOptionType: "include" | "only"

Defines values for DeleteSnapshotsOptionType. Possible values include: 'include', 'only'

readonly
enum

{string}

DirectoryCreateResponse

DirectoryCreateResponse: DirectoryCreateHeaders & object

Contains response data for the create operation.

DirectoryDeleteResponse

DirectoryDeleteResponse: DirectoryDeleteHeaders & object

Contains response data for the deleteMethod operation.

DirectoryGetAccessControlResponse

DirectoryGetAccessControlResponse: DirectoryGetAccessControlHeaders & object

Contains response data for the getAccessControl operation.

DirectoryRenameResponse

DirectoryRenameResponse: DirectoryRenameHeaders & object

Contains response data for the rename operation.

DirectorySetAccessControlResponse

DirectorySetAccessControlResponse: DirectorySetAccessControlHeaders & object

Contains response data for the setAccessControl operation.

EncryptionAlgorithmType

EncryptionAlgorithmType: "AES256"

Defines values for EncryptionAlgorithmType. Possible values include: 'AES256'

readonly
enum

{string}

GeoReplicationStatusType

GeoReplicationStatusType: "live" | "bootstrap" | "unavailable"

Defines values for GeoReplicationStatusType. Possible values include: 'live', 'bootstrap', 'unavailable'

readonly
enum

{string}

LeaseDurationType

LeaseDurationType: "infinite" | "fixed"

Defines values for LeaseDurationType. Possible values include: 'infinite', 'fixed'

readonly
enum

{string}

LeaseStateType

LeaseStateType: "available" | "leased" | "expired" | "breaking" | "broken"

Defines values for LeaseStateType. Possible values include: 'available', 'leased', 'expired', 'breaking', 'broken'

readonly
enum

{string}

LeaseStatusType

LeaseStatusType: "locked" | "unlocked"

Defines values for LeaseStatusType. Possible values include: 'locked', 'unlocked'

readonly
enum

{string}

ListBlobsIncludeItem

ListBlobsIncludeItem: "copy" | "deleted" | "metadata" | "snapshots" | "uncommittedblobs"

Defines values for ListBlobsIncludeItem. Possible values include: 'copy', 'deleted', 'metadata', 'snapshots', 'uncommittedblobs'

readonly
enum

{string}

ListContainersIncludeType

ListContainersIncludeType: "metadata"

Defines values for ListContainersIncludeType. Possible values include: 'metadata'

readonly
enum

{string}

Operation

Operation: function

Operation is an async function to be executed and managed by Batch.

Type declaration

    • (): Promise<any>
    • Returns Promise<any>

OutgoingHandler

OutgoingHandler: function

OutgoingHandler is an async function triggered by BufferScheduler.

Type declaration

    • (buffer: Buffer, offset?: undefined | number): Promise<any>
    • Parameters

      • buffer: Buffer
      • Optional offset: undefined | number

      Returns Promise<any>

PageBlobClearPagesResponse

PageBlobClearPagesResponse: PageBlobClearPagesHeaders & object

Contains response data for the clearPages operation.

PageBlobCopyIncrementalResponse

PageBlobCopyIncrementalResponse: PageBlobCopyIncrementalHeaders & object

Contains response data for the copyIncremental operation.

PageBlobCreateResponse

PageBlobCreateResponse: PageBlobCreateHeaders & object

Contains response data for the create operation.

PageBlobGetPageRangesDiffResponse

PageBlobGetPageRangesDiffResponse: PageList & PageBlobGetPageRangesDiffHeaders & object

Contains response data for the getPageRangesDiff operation.

PageBlobGetPageRangesResponse

PageBlobGetPageRangesResponse: PageList & PageBlobGetPageRangesHeaders & object

Contains response data for the getPageRanges operation.

PageBlobResizeResponse

PageBlobResizeResponse: PageBlobResizeHeaders & object

Contains response data for the resize operation.

PageBlobUpdateSequenceNumberResponse

PageBlobUpdateSequenceNumberResponse: PageBlobUpdateSequenceNumberHeaders & object

Contains response data for the updateSequenceNumber operation.

PageBlobUploadPagesFromURLResponse

PageBlobUploadPagesFromURLResponse: PageBlobUploadPagesFromURLHeaders & object

Contains response data for the uploadPagesFromURL operation.

PageBlobUploadPagesResponse

PageBlobUploadPagesResponse: PageBlobUploadPagesHeaders & object

Contains response data for the uploadPages operation.

PathRenameMode

PathRenameMode: "legacy" | "posix"

Defines values for PathRenameMode. Possible values include: 'legacy', 'posix'

readonly
enum

{string}

PublicAccessType

PublicAccessType: "container" | "blob"

Defines values for PublicAccessType. Possible values include: 'container', 'blob'

readonly
enum

{string}

ReadableStreamGetter

ReadableStreamGetter: function

Type declaration

    • (offset: number): Promise<ReadableStream>
    • Parameters

      • offset: number

      Returns Promise<ReadableStream>

RehydratePriority

RehydratePriority: "High" | "Standard"

Defines values for RehydratePriority. Possible values include: 'High', 'Standard'

readonly
enum

{string}

SequenceNumberActionType

SequenceNumberActionType: "max" | "update" | "increment"

Defines values for SequenceNumberActionType. Possible values include: 'max', 'update', 'increment'

readonly
enum

{string}

ServiceGetAccountInfoResponse

ServiceGetAccountInfoResponse: ServiceGetAccountInfoHeaders & object

Contains response data for the getAccountInfo operation.

ServiceGetPropertiesResponse

ServiceGetPropertiesResponse: StorageServiceProperties & ServiceGetPropertiesHeaders & object

Contains response data for the getProperties operation.

ServiceGetStatisticsResponse

ServiceGetStatisticsResponse: StorageServiceStats & ServiceGetStatisticsHeaders & object

Contains response data for the getStatistics operation.

ServiceGetUserDelegationKeyResponse

ServiceGetUserDelegationKeyResponse: UserDelegationKey & ServiceGetUserDelegationKeyHeaders & object

Contains response data for the getUserDelegationKey operation.

ServiceListContainersSegmentResponse

ServiceListContainersSegmentResponse: ListContainersSegmentResponse & ServiceListContainersSegmentHeaders & object

Contains response data for the listContainersSegment operation.

ServiceSetPropertiesResponse

ServiceSetPropertiesResponse: ServiceSetPropertiesHeaders & object

Contains response data for the setProperties operation.

ServiceSubmitBatchResponse

ServiceSubmitBatchResponse: ParsedBatchResponse & ServiceSubmitBatchHeaders & object

Contains response data for the submitBatch operation.

SkuName

SkuName: "Standard_LRS" | "Standard_GRS" | "Standard_RAGRS" | "Standard_ZRS" | "Premium_LRS"

Defines values for SkuName. Possible values include: 'Standard_LRS', 'Standard_GRS', 'Standard_RAGRS', 'Standard_ZRS', 'Premium_LRS'

readonly
enum

{string}

StorageErrorCode

StorageErrorCode: "AccountAlreadyExists" | "AccountBeingCreated" | "AccountIsDisabled" | "AuthenticationFailed" | "AuthorizationFailure" | "ConditionHeadersNotSupported" | "ConditionNotMet" | "EmptyMetadataKey" | "InsufficientAccountPermissions" | "InternalError" | "InvalidAuthenticationInfo" | "InvalidHeaderValue" | "InvalidHttpVerb" | "InvalidInput" | "InvalidMd5" | "InvalidMetadata" | "InvalidQueryParameterValue" | "InvalidRange" | "InvalidResourceName" | "InvalidUri" | "InvalidXmlDocument" | "InvalidXmlNodeValue" | "Md5Mismatch" | "MetadataTooLarge" | "MissingContentLengthHeader" | "MissingRequiredQueryParameter" | "MissingRequiredHeader" | "MissingRequiredXmlNode" | "MultipleConditionHeadersNotSupported" | "OperationTimedOut" | "OutOfRangeInput" | "OutOfRangeQueryParameterValue" | "RequestBodyTooLarge" | "ResourceTypeMismatch" | "RequestUrlFailedToParse" | "ResourceAlreadyExists" | "ResourceNotFound" | "ServerBusy" | "UnsupportedHeader" | "UnsupportedXmlNode" | "UnsupportedQueryParameter" | "UnsupportedHttpVerb" | "AppendPositionConditionNotMet" | "BlobAlreadyExists" | "BlobNotFound" | "BlobOverwritten" | "BlobTierInadequateForContentLength" | "BlockCountExceedsLimit" | "BlockListTooLong" | "CannotChangeToLowerTier" | "CannotVerifyCopySource" | "ContainerAlreadyExists" | "ContainerBeingDeleted" | "ContainerDisabled" | "ContainerNotFound" | "ContentLengthLargerThanTierLimit" | "CopyAcrossAccountsNotSupported" | "CopyIdMismatch" | "FeatureVersionMismatch" | "IncrementalCopyBlobMismatch" | "IncrementalCopyOfEralierVersionSnapshotNotAllowed" | "IncrementalCopySourceMustBeSnapshot" | "InfiniteLeaseDurationRequired" | "InvalidBlobOrBlock" | "InvalidBlobTier" | "InvalidBlobType" | "InvalidBlockId" | "InvalidBlockList" | "InvalidOperation" | "InvalidPageRange" | "InvalidSourceBlobType" | "InvalidSourceBlobUrl" | "InvalidVersionForPageBlobOperation" | "LeaseAlreadyPresent" | "LeaseAlreadyBroken" | "LeaseIdMismatchWithBlobOperation" | "LeaseIdMismatchWithContainerOperation" | "LeaseIdMismatchWithLeaseOperation" | "LeaseIdMissing" | "LeaseIsBreakingAndCannotBeAcquired" | "LeaseIsBreakingAndCannotBeChanged" | "LeaseIsBrokenAndCannotBeRenewed" | "LeaseLost" | "LeaseNotPresentWithBlobOperation" | "LeaseNotPresentWithContainerOperation" | "LeaseNotPresentWithLeaseOperation" | "MaxBlobSizeConditionNotMet" | "NoPendingCopyOperation" | "OperationNotAllowedOnIncrementalCopyBlob" | "PendingCopyOperation" | "PreviousSnapshotCannotBeNewer" | "PreviousSnapshotNotFound" | "PreviousSnapshotOperationNotSupported" | "SequenceNumberConditionNotMet" | "SequenceNumberIncrementTooLarge" | "SnapshotCountExceeded" | "SnaphotOperationRateExceeded" | "SnapshotsPresent" | "SourceConditionNotMet" | "SystemInUse" | "TargetConditionNotMet" | "UnauthorizedBlobOverwrite" | "BlobBeingRehydrated" | "BlobArchived" | "BlobNotArchived"

Defines values for StorageErrorCode. Possible values include: 'AccountAlreadyExists', 'AccountBeingCreated', 'AccountIsDisabled', 'AuthenticationFailed', 'AuthorizationFailure', 'ConditionHeadersNotSupported', 'ConditionNotMet', 'EmptyMetadataKey', 'InsufficientAccountPermissions', 'InternalError', 'InvalidAuthenticationInfo', 'InvalidHeaderValue', 'InvalidHttpVerb', 'InvalidInput', 'InvalidMd5', 'InvalidMetadata', 'InvalidQueryParameterValue', 'InvalidRange', 'InvalidResourceName', 'InvalidUri', 'InvalidXmlDocument', 'InvalidXmlNodeValue', 'Md5Mismatch', 'MetadataTooLarge', 'MissingContentLengthHeader', 'MissingRequiredQueryParameter', 'MissingRequiredHeader', 'MissingRequiredXmlNode', 'MultipleConditionHeadersNotSupported', 'OperationTimedOut', 'OutOfRangeInput', 'OutOfRangeQueryParameterValue', 'RequestBodyTooLarge', 'ResourceTypeMismatch', 'RequestUrlFailedToParse', 'ResourceAlreadyExists', 'ResourceNotFound', 'ServerBusy', 'UnsupportedHeader', 'UnsupportedXmlNode', 'UnsupportedQueryParameter', 'UnsupportedHttpVerb', 'AppendPositionConditionNotMet', 'BlobAlreadyExists', 'BlobNotFound', 'BlobOverwritten', 'BlobTierInadequateForContentLength', 'BlockCountExceedsLimit', 'BlockListTooLong', 'CannotChangeToLowerTier', 'CannotVerifyCopySource', 'ContainerAlreadyExists', 'ContainerBeingDeleted', 'ContainerDisabled', 'ContainerNotFound', 'ContentLengthLargerThanTierLimit', 'CopyAcrossAccountsNotSupported', 'CopyIdMismatch', 'FeatureVersionMismatch', 'IncrementalCopyBlobMismatch', 'IncrementalCopyOfEralierVersionSnapshotNotAllowed', 'IncrementalCopySourceMustBeSnapshot', 'InfiniteLeaseDurationRequired', 'InvalidBlobOrBlock', 'InvalidBlobTier', 'InvalidBlobType', 'InvalidBlockId', 'InvalidBlockList', 'InvalidOperation', 'InvalidPageRange', 'InvalidSourceBlobType', 'InvalidSourceBlobUrl', 'InvalidVersionForPageBlobOperation', 'LeaseAlreadyPresent', 'LeaseAlreadyBroken', 'LeaseIdMismatchWithBlobOperation', 'LeaseIdMismatchWithContainerOperation', 'LeaseIdMismatchWithLeaseOperation', 'LeaseIdMissing', 'LeaseIsBreakingAndCannotBeAcquired', 'LeaseIsBreakingAndCannotBeChanged', 'LeaseIsBrokenAndCannotBeRenewed', 'LeaseLost', 'LeaseNotPresentWithBlobOperation', 'LeaseNotPresentWithContainerOperation', 'LeaseNotPresentWithLeaseOperation', 'MaxBlobSizeConditionNotMet', 'NoPendingCopyOperation', 'OperationNotAllowedOnIncrementalCopyBlob', 'PendingCopyOperation', 'PreviousSnapshotCannotBeNewer', 'PreviousSnapshotNotFound', 'PreviousSnapshotOperationNotSupported', 'SequenceNumberConditionNotMet', 'SequenceNumberIncrementTooLarge', 'SnapshotCountExceeded', 'SnaphotOperationRateExceeded', 'SnapshotsPresent', 'SourceConditionNotMet', 'SystemInUse', 'TargetConditionNotMet', 'UnauthorizedBlobOverwrite', 'BlobBeingRehydrated', 'BlobArchived', 'BlobNotArchived'

readonly
enum

{string}

SyncCopyStatusType

SyncCopyStatusType: "success"

Defines values for SyncCopyStatusType. Possible values include: 'success'

readonly
enum

{string}

Variables

Const BATCH_MAX_PAYLOAD_IN_BYTES

BATCH_MAX_PAYLOAD_IN_BYTES: number = 4 * SIZE_1_MB

Const BATCH_MAX_REQUEST

BATCH_MAX_REQUEST: 256 = 256

Const BLOCK_BLOB_MAX_BLOCKS

BLOCK_BLOB_MAX_BLOCKS: number = 50000

Const BLOCK_BLOB_MAX_STAGE_BLOCK_BYTES

BLOCK_BLOB_MAX_STAGE_BLOCK_BYTES: number = 100 * 1024 * 1024

Const BLOCK_BLOB_MAX_UPLOAD_BLOB_BYTES

BLOCK_BLOB_MAX_UPLOAD_BLOB_BYTES: number = 256 * 1024 * 1024

Const DEFAULT_BLOB_DOWNLOAD_BLOCK_BYTES

DEFAULT_BLOB_DOWNLOAD_BLOCK_BYTES: number = 4 * 1024 * 1024

Const DEFAULT_MAX_DOWNLOAD_RETRY_REQUESTS

DEFAULT_MAX_DOWNLOAD_RETRY_REQUESTS: number = 5

Const ETagAny

ETagAny: "*" = "*"

Const ETagNone

ETagNone: "" = ""

Const EncryptionAlgorithmAES25

EncryptionAlgorithmAES25: "AES256" = "AES256"

Const HTTP_LINE_ENDING

HTTP_LINE_ENDING: "" = ""

Const HTTP_VERSION_1_1

HTTP_VERSION_1_1: "HTTP/1.1" = "HTTP/1.1"

Const SDK_VERSION

SDK_VERSION: string = "10.5.0"

Const SERVICE_VERSION

SERVICE_VERSION: string = "2019-02-02"

Const SIZE_1_MB

SIZE_1_MB: number = 1 * 1024 * 1024

Functions

NewRetryPolicyFactory

  • NewRetryPolicyFactory(retryOptions?: IRetryOptions): RequestPolicyFactory

appendToURLPath

  • appendToURLPath(url: string, name: string): string
  • Append a string to URL path. Will remove duplicated "/" in front of the string when URL path ends with a "/".

    export

    Parameters

    • url: string

      Source URL string

    • name: string

      String to be appended to URL

    Returns string

    An updated URL string

base64decode

  • base64decode(encodedString: string): string

base64encode

  • base64encode(content: string): string

blobToArrayBuffer

  • blobToArrayBuffer(blob: Blob): Promise<ArrayBuffer>
  • Convert a Browser Blob object into ArrayBuffer.

    export

    Parameters

    • blob: Blob

    Returns Promise<ArrayBuffer>

blobToString

  • blobToString(blob: Blob): Promise<string>
  • Convert a Browser Blob object into string.

    export

    Parameters

    • blob: Blob

    Returns Promise<string>

delay

  • delay(timeInMs: number, aborter?: AbortSignalLike, abortError?: Error): Promise<Object>
  • Delay specified time interval.

    export

    Parameters

    • timeInMs: number
    • Optional aborter: AbortSignalLike
    • Optional abortError: Error

    Returns Promise<Object>

downloadBlobToBuffer

  • ONLY AVAILABLE IN NODE.JS RUNTIME.

    Downloads an Azure Blob in parallel to a buffer. Offset and count are optional, pass 0 for both to download the entire blob.

    export

    Parameters

    • aborter: Aborter

      Create a new Aborter instance with Aborter.none or Aborter.timeout(), goto documents of Aborter for more examples about request cancellation

    • buffer: Buffer

      Buffer to be fill, must have length larger than count

    • blobURL: BlobURL

      A BlobURL object

    • offset: number

      From which position of the block blob to download, in bytes

    • Optional count: undefined | number
    • Default value options: IDownloadFromBlobOptions = {}

    Returns Promise<void>

ensureCpkIfSpecified

  • ensureCpkIfSpecified(cpk: CpkInfo | undefined, isHttps: boolean): void

escapeURLPath

  • escapeURLPath(url: string): string

generateAccountSASQueryParameters

generateBlobSASQueryParameters

  • ONLY AVAILABLE IN NODE.JS RUNTIME.

    Creates an instance of SASQueryParameters.

    Only accepts required settings needed to create a SAS. For optional settings please set corresponding properties directly, such as permissions, startTime and identifier.

    WARNING: When identifier is not provided, permissions and expiryTime are required. You MUST assign value to identifier or expiryTime & permissions manually if you initial with this constructor.

    example

    // Generate service level SAS for a container const containerSAS = generateBlobSASQueryParameters({ containerName, // Required permissions: ContainerSASPermissions.parse("racwdl").toString(), // Required startTime: new Date(), // Required expiryTime: tmr, // Optional. Date type ipRange: { start: "0.0.0.0", end: "255.255.255.255" }, // Optional protocol: SASProtocol.HTTPSandHTTP, // Optional version: "2016-05-31" // Optional }, sharedKeyCredential // SharedKeyCredential ).toString();

    example

    // Generate service level SAS for a container with identifier // startTime & permissions are optional when identifier is provided const identifier = "unique-id"; await containerURL.setAccessPolicy(Aborter.none, undefined, [ { accessPolicy: { expiry: tmr, // Date type permission: ContainerSASPermissions.parse("racwdl").toString(), start: now // Date type }, id: identifier } ]);

    const containerSAS = generateBlobSASQueryParameters( { containerName, // Required identifier // Required }, sharedKeyCredential // SharedKeyCredential ).toString();

    example

    // Generate service level SAS for a blob const blobSAS = generateBlobSASQueryParameters({ containerName, // Required blobName, // Required permissions: BlobSASPermissions.parse("racwd").toString(), // Required startTime: new Date(), // Required expiryTime: tmr, // Optional. Date type cacheControl: "cache-control-override", // Optional contentDisposition: "content-disposition-override", // Optional contentEncoding: "content-encoding-override", // Optional contentLanguage: "content-language-override", // Optional contentType: "content-type-override", // Optional ipRange: { start: "0.0.0.0", end: "255.255.255.255" }, // Optional protocol: SASProtocol.HTTPSandHTTP, // Optional version: "2016-05-31" // Optional }, sharedKeyCredential // SharedKeyCredential ).toString();

    export

    Parameters

    Returns SASQueryParameters

  • ONLY AVAILABLE IN NODE.JS RUNTIME.

    Creates an instance of SASQueryParameters. WARNING: identifier will be ignored when generating user delegation SAS, permissions and expiryTime are required.

    example

    // Generate user delegation SAS for a container const userDelegationKey = await serviceURL.getUserDelegationKey(aborter, startTime, expiryTime); const containerSAS = generateBlobSASQueryParameters({ containerName, // Required permissions: ContainerSASPermissions.parse("racwdl").toString(), // Required startTime, // Required. Date type expiryTime, // Optional. Date type ipRange: { start: "0.0.0.0", end: "255.255.255.255" }, // Optional protocol: SASProtocol.HTTPSandHTTP, // Optional version: "2018-11-09" // Must >= 2018-11-09 to generate user delegation SAS }, userDelegationKey, // UserDelegationKey accountName ).toString();

    export

    Parameters

    • blobSASSignatureValues: IBlobSASSignatureValues
    • userDelegationKey: UserDelegationKey

      Return value of ServiceURL.getUserDelegationKey()

    • accountName: string

    Returns SASQueryParameters

generateBlockID

  • generateBlockID(blockIDPrefix: string, blockIndex: number): string
  • Generate a 64 bytes base64 block ID string.

    export

    Parameters

    • blockIDPrefix: string
    • blockIndex: number

    Returns string

getBodyAsText

  • getBodyAsText(batchResponse: Models.ServiceSubmitBatchResponse): Promise<string>
  • Parameters

    • batchResponse: Models.ServiceSubmitBatchResponse

    Returns Promise<string>

getURLParameter

  • getURLParameter(url: string, name: string): string | string[] | undefined
  • Get URL parameter by name.

    export

    Parameters

    • url: string
    • name: string

    Returns string | string[] | undefined

getURLPath

  • getURLPath(url: string): string | undefined
  • Get URL path from an URL string.

    export

    Parameters

    • url: string

      Source URL string

    Returns string | undefined

getURLPathAndQuery

  • getURLPathAndQuery(url: string): string | undefined
  • Get URL path and query from an URL string.

    export

    Parameters

    • url: string

      Source URL string

    Returns string | undefined

getURLQueries

  • getURLQueries(url: string): object
  • Get URL query key value pairs from an URL string.

    export

    Parameters

    • url: string

    Returns object

    • [key: string]: string

getURLScheme

  • getURLScheme(url: string): string | undefined
  • Get URL scheme from an URL string.

    export

    Parameters

    • url: string

      Source URL string

    Returns string | undefined

iEqual

  • iEqual(str1: string, str2: string): boolean
  • If two strings are equal when compared case insensitive.

    export

    Parameters

    • str1: string
    • str2: string

    Returns boolean

ipRangeToString

  • ipRangeToString(ipRange: IIPRange): string
  • Generate IPRange format string. For example:

    "8.8.8.8" or "1.1.1.1-255.255.255.255"

    export

    Parameters

    Returns string

padStart

  • padStart(currentString: string, targetLength: number, padString?: string): string
  • String.prototype.padStart()

    export

    Parameters

    • currentString: string
    • targetLength: number
    • Default value padString: string = " "

    Returns string

rangeToString

  • rangeToString(iRange: IRange): string
  • Generate a range string. For example:

    "bytes=255-" or "bytes=0-511"

    export

    Parameters

    Returns string

setURLHost

  • setURLHost(url: string, host: string): string
  • Set URL host.

    export

    Parameters

    • url: string

      Source URL string

    • host: string

      New host string

    Returns string

    An updated URL string

setURLParameter

  • setURLParameter(url: string, name: string, value?: undefined | string): string
  • Set URL parameter name and value. If name exists in URL parameters, old value will be replaced by name key. If not provide value, the parameter will be deleted.

    export

    Parameters

    • url: string

      Source URL string

    • name: string

      Parameter name

    • Optional value: undefined | string

    Returns string

    An updated URL string

streamToBuffer

  • streamToBuffer(stream: ReadableStream, buffer: Buffer, offset: number, end: number, encoding?: undefined | string): Promise<void>
  • Reads a readable stream into buffer. Fill the buffer from offset to end.

    export

    Parameters

    • stream: ReadableStream

      A Node.js Readable stream

    • buffer: Buffer

      Buffer to be filled, length must >= offset

    • offset: number

      From which position in the buffer to be filled, inclusive

    • end: number

      To which position in the buffer to be filled, exclusive

    • Optional encoding: undefined | string

    Returns Promise<void>

streamToBuffer2

  • streamToBuffer2(stream: ReadableStream, buffer: Buffer, encoding?: undefined | string): Promise<number>
  • Reads a readable stream into buffer entirely.

    export
    throws

    {RangeError} If buffer size is not big enough.

    Parameters

    • stream: ReadableStream

      A Node.js Readable stream

    • buffer: Buffer

      Buffer to be filled, length must >= offset

    • Optional encoding: undefined | string

    Returns Promise<number>

    with the count of bytes read.

toAccessTier

truncatedISO8061Date

  • truncatedISO8061Date(date: Date, withMilliseconds?: boolean): string
  • Rounds a date off to seconds.

    export

    Parameters

    • date: Date
    • Default value withMilliseconds: boolean = true

    Returns string

    Date string in ISO8061 format, with or without 7 milliseconds component

uploadBrowserDataToBlockBlob

  • ONLY AVAILABLE IN BROWSERS.

    Uploads a browser Blob/File/ArrayBuffer/ArrayBufferView object to block blob.

    When buffer length <= 256MB, this method will use 1 upload call to finish the upload. Otherwise, this method will call stageBlock to upload blocks, and finally call commitBlockList to commit the block list.

    export

    Parameters

    • aborter: Aborter

      Create a new Aborter instance with Aborter.none or Aborter.timeout(), goto documents of Aborter for more examples about request cancellation

    • browserData: Blob | ArrayBuffer | ArrayBufferView

      Blob, File, ArrayBuffer or ArrayBufferView

    • blockBlobURL: BlockBlobURL
    • Optional options: IUploadToBlockBlobOptions

    Returns Promise<BlobUploadCommonResponse>

uploadFileToBlockBlob

  • ONLY AVAILABLE IN NODE.JS RUNTIME.

    Uploads a local file in blocks to a block blob.

    When file size <= 256MB, this method will use 1 upload call to finish the upload. Otherwise, this method will call stageBlock to upload blocks, and finally call commitBlockList to commit the block list.

    export

    Parameters

    • aborter: Aborter

      Create a new Aborter instance with Aborter.none or Aborter.timeout(), goto documents of Aborter for more examples about request cancellation

    • filePath: string

      Full path of local file

    • blockBlobURL: BlockBlobURL

      BlockBlobURL

    • Optional options: IUploadToBlockBlobOptions

    Returns Promise<BlobUploadCommonResponse>

    ICommonResponse

uploadStreamToBlockBlob

  • ONLY AVAILABLE IN NODE.JS RUNTIME.

    Uploads a Node.js Readable stream into block blob.

    PERFORMANCE IMPROVEMENT TIPS:

    • Input stream highWaterMark is better to set a same value with bufferSize parameter, which will avoid Buffer.concat() operations.
    export

    Parameters

    • aborter: Aborter

      Create a new Aborter instance with Aborter.none or Aborter.timeout(), goto documents of Aborter for more examples about request cancellation

    • stream: Readable

      Node.js Readable stream

    • blockBlobURL: BlockBlobURL

      A BlockBlobURL instance

    • bufferSize: number

      Size of every buffer allocated, also the block size in the uploaded block blob

    • maxBuffers: number

      Max buffers will allocate during uploading, positive correlation with max uploading concurrency

    • Default value options: IUploadStreamToBlockBlobOptions = {}

    Returns Promise<BlobUploadCommonResponse>

utf8ByteLength

  • utf8ByteLength(str: string): number

Object literals

Const AccessPolicy

AccessPolicy: object

An Access policy

expiry

expiry: string

the date-time the policy expires NOTE: This entity will be treated as a string instead of a Date because the API can potentially deal with a higher precision value than what is supported by JavaScript.

permission

permission: string

the permissions for the acl policy

start

start: string

the date-time the policy is active NOTE: This entity will be treated as a string instead of a Date because the API can potentially deal with a higher precision value than what is supported by JavaScript.

serializedName

serializedName: string = "AccessPolicy"

type

type: object

className

className: string = "AccessPolicy"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

expiry

expiry: object

required

required: true = true

serializedName

serializedName: string = "Expiry"

xmlName

xmlName: string = "Expiry"

type

type: object

name

name: "String" = "String"

permission

permission: object

required

required: true = true

serializedName

serializedName: string = "Permission"

xmlName

xmlName: string = "Permission"

type

type: object

name

name: "String" = "String"

start

start: object

required

required: true = true

serializedName

serializedName: string = "Start"

xmlName

xmlName: string = "Start"

type

type: object

name

name: "String" = "String"

Const AppendBlobAppendBlockFromUrlHeaders

AppendBlobAppendBlockFromUrlHeaders: object

Defines headers for AppendBlockFromUrl operation.

Optional blobAppendOffset

blobAppendOffset: undefined | string

This response header is returned only for append operations. It returns the offset at which the block was committed, in bytes.

Optional blobCommittedBlockCount

blobCommittedBlockCount: undefined | number

The number of committed blocks present in the blob. This header is returned only for append blobs.

Optional contentMD5

contentMD5: Uint8Array

If the blob has an MD5 hash and this operation is to read the full blob, this response header is returned so that the client can check for message content integrity.

Optional date

date: Date

UTC date/time value generated by the service that indicates the time at which the response was initiated

Optional eTag

eTag: undefined | string

The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes.

Optional encryptionKeySha256

encryptionKeySha256: undefined | string

The SHA-256 hash of the encryption key used to encrypt the block. This header is only returned when the block was encrypted with a customer-provided key.

Optional errorCode

errorCode: undefined | string

Optional lastModified

lastModified: Date

Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob.

Optional requestId

requestId: undefined | string

This header uniquely identifies the request that was made and can be used for troubleshooting the request.

Optional version

version: undefined | string

Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above.

Optional xMsContentCrc64

xMsContentCrc64: Uint8Array

This header is returned so that the client can check for message content integrity. The value of this header is computed by the Blob service; it is not necessarily the same value specified in the request headers.

serializedName

serializedName: string = "appendblob-appendblockfromurl-headers"

type

type: object

className

className: string = "AppendBlobAppendBlockFromUrlHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

blobAppendOffset

blobAppendOffset: object

serializedName

serializedName: string = "x-ms-blob-append-offset"

type

type: object

name

name: "String" = "String"

blobCommittedBlockCount

blobCommittedBlockCount: object

serializedName

serializedName: string = "x-ms-blob-committed-block-count"

type

type: object

name

name: "Number" = "Number"

contentMD5

contentMD5: object

serializedName

serializedName: string = "content-md5"

type

type: object

name

name: "ByteArray" = "ByteArray"

date

date: object

serializedName

serializedName: string = "date"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

encryptionKeySha256

encryptionKeySha256: object

serializedName

serializedName: string = "x-ms-encryption-key-sha256"

type

type: object

name

name: "String" = "String"

errorCode

errorCode: object

serializedName

serializedName: string = "x-ms-error-code"

type

type: object

name

name: "String" = "String"

lastModified

lastModified: object

serializedName

serializedName: string = "last-modified"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

requestId

requestId: object

serializedName

serializedName: string = "x-ms-request-id"

type

type: object

name

name: "String" = "String"

version

version: object

serializedName

serializedName: string = "x-ms-version"

type

type: object

name

name: "String" = "String"

xMsContentCrc64

xMsContentCrc64: object

serializedName

serializedName: string = "x-ms-content-crc64"

type

type: object

name

name: "ByteArray" = "ByteArray"

Const AppendBlobAppendBlockHeaders

AppendBlobAppendBlockHeaders: object

Defines headers for AppendBlock operation.

Optional blobAppendOffset

blobAppendOffset: undefined | string

This response header is returned only for append operations. It returns the offset at which the block was committed, in bytes.

Optional blobCommittedBlockCount

blobCommittedBlockCount: undefined | number

The number of committed blocks present in the blob. This header is returned only for append blobs.

Optional clientRequestId

clientRequestId: undefined | string

If a client request id header is sent in the request, this header will be present in the response with the same value.

Optional contentMD5

contentMD5: Uint8Array

If the blob has an MD5 hash and this operation is to read the full blob, this response header is returned so that the client can check for message content integrity.

Optional date

date: Date

UTC date/time value generated by the service that indicates the time at which the response was initiated

Optional eTag

eTag: undefined | string

The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes.

Optional encryptionKeySha256

encryptionKeySha256: undefined | string

The SHA-256 hash of the encryption key used to encrypt the block. This header is only returned when the block was encrypted with a customer-provided key.

Optional errorCode

errorCode: undefined | string

Optional isServerEncrypted

isServerEncrypted: undefined | false | true

The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise.

Optional lastModified

lastModified: Date

Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob.

Optional requestId

requestId: undefined | string

This header uniquely identifies the request that was made and can be used for troubleshooting the request.

Optional version

version: undefined | string

Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above.

Optional xMsContentCrc64

xMsContentCrc64: Uint8Array

This header is returned so that the client can check for message content integrity. The value of this header is computed by the Blob service; it is not necessarily the same value specified in the request headers.

serializedName

serializedName: string = "appendblob-appendblock-headers"

type

type: object

className

className: string = "AppendBlobAppendBlockHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

blobAppendOffset

blobAppendOffset: object

serializedName

serializedName: string = "x-ms-blob-append-offset"

type

type: object

name

name: "String" = "String"

blobCommittedBlockCount

blobCommittedBlockCount: object

serializedName

serializedName: string = "x-ms-blob-committed-block-count"

type

type: object

name

name: "Number" = "Number"

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "x-ms-client-request-id"

type

type: object

name

name: "String" = "String"

contentMD5

contentMD5: object

serializedName

serializedName: string = "content-md5"

type

type: object

name

name: "ByteArray" = "ByteArray"

date

date: object

serializedName

serializedName: string = "date"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

encryptionKeySha256

encryptionKeySha256: object

serializedName

serializedName: string = "x-ms-encryption-key-sha256"

type

type: object

name

name: "String" = "String"

errorCode

errorCode: object

serializedName

serializedName: string = "x-ms-error-code"

type

type: object

name

name: "String" = "String"

isServerEncrypted

isServerEncrypted: object

serializedName

serializedName: string = "x-ms-request-server-encrypted"

type

type: object

name

name: "Boolean" = "Boolean"

lastModified

lastModified: object

serializedName

serializedName: string = "last-modified"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

requestId

requestId: object

serializedName

serializedName: string = "x-ms-request-id"

type

type: object

name

name: "String" = "String"

version

version: object

serializedName

serializedName: string = "x-ms-version"

type

type: object

name

name: "String" = "String"

xMsContentCrc64

xMsContentCrc64: object

serializedName

serializedName: string = "x-ms-content-crc64"

type

type: object

name

name: "ByteArray" = "ByteArray"

Const AppendBlobCreateHeaders

AppendBlobCreateHeaders: object

Defines headers for Create operation.

Optional clientRequestId

clientRequestId: undefined | string

If a client request id header is sent in the request, this header will be present in the response with the same value.

Optional contentMD5

contentMD5: Uint8Array

If the blob has an MD5 hash and this operation is to read the full blob, this response header is returned so that the client can check for message content integrity.

Optional date

date: Date

UTC date/time value generated by the service that indicates the time at which the response was initiated

Optional eTag

eTag: undefined | string

The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes.

Optional encryptionKeySha256

encryptionKeySha256: undefined | string

The SHA-256 hash of the encryption key used to encrypt the blob. This header is only returned when the blob was encrypted with a customer-provided key.

Optional errorCode

errorCode: undefined | string

Optional isServerEncrypted

isServerEncrypted: undefined | false | true

The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise.

Optional lastModified

lastModified: Date

Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob.

Optional requestId

requestId: undefined | string

This header uniquely identifies the request that was made and can be used for troubleshooting the request.

Optional version

version: undefined | string

Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above.

serializedName

serializedName: string = "appendblob-create-headers"

type

type: object

className

className: string = "AppendBlobCreateHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "x-ms-client-request-id"

type

type: object

name

name: "String" = "String"

contentMD5

contentMD5: object

serializedName

serializedName: string = "content-md5"

type

type: object

name

name: "ByteArray" = "ByteArray"

date

date: object

serializedName

serializedName: string = "date"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

encryptionKeySha256

encryptionKeySha256: object

serializedName

serializedName: string = "x-ms-encryption-key-sha256"

type

type: object

name

name: "String" = "String"

errorCode

errorCode: object

serializedName

serializedName: string = "x-ms-error-code"

type

type: object

name

name: "String" = "String"

isServerEncrypted

isServerEncrypted: object

serializedName

serializedName: string = "x-ms-request-server-encrypted"

type

type: object

name

name: "Boolean" = "Boolean"

lastModified

lastModified: object

serializedName

serializedName: string = "last-modified"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

requestId

requestId: object

serializedName

serializedName: string = "x-ms-request-id"

type

type: object

name

name: "String" = "String"

version

version: object

serializedName

serializedName: string = "x-ms-version"

type

type: object

name

name: "String" = "String"

Const AppendPositionAccessConditions

AppendPositionAccessConditions: object

Additional parameters for a set of operations, such as: AppendBlob_appendBlock, AppendBlob_appendBlockFromUrl.

Optional appendPosition

appendPosition: undefined | number

Optional conditional header, used only for the Append Block operation. A number indicating the byte offset to compare. Append Block will succeed only if the append position is equal to this number. If it is not, the request will fail with the AppendPositionConditionNotMet error (HTTP status code 412 - Precondition Failed).

Optional maxSize

maxSize: undefined | number

Optional conditional header. The max length in bytes permitted for the append blob. If the Append Block operation would cause the blob to exceed that limit or if the blob size is already greater than the value specified in this header, the request will fail with MaxBlobSizeConditionNotMet error (HTTP status code 412 - Precondition Failed).

xmlName

xmlName: string = "append-position-access-conditions"

type

type: object

className

className: string = "AppendPositionAccessConditions"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

appendPosition

appendPosition: object

xmlName

xmlName: string = "appendPosition"

type

type: object

name

name: "Number" = "Number"

maxSize

maxSize: object

xmlName

xmlName: string = "maxSize"

type

type: object

name

name: "Number" = "Number"

Const BlobAbortCopyFromURLHeaders

BlobAbortCopyFromURLHeaders: object

Defines headers for AbortCopyFromURL operation.

Optional clientRequestId

clientRequestId: undefined | string

If a client request id header is sent in the request, this header will be present in the response with the same value.

Optional date

date: Date

UTC date/time value generated by the service that indicates the time at which the response was initiated

Optional errorCode

errorCode: undefined | string

Optional requestId

requestId: undefined | string

This header uniquely identifies the request that was made and can be used for troubleshooting the request.

Optional version

version: undefined | string

Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above.

serializedName

serializedName: string = "blob-abortcopyfromurl-headers"

type

type: object

className

className: string = "BlobAbortCopyFromURLHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "x-ms-client-request-id"

type

type: object

name

name: "String" = "String"

date

date: object

serializedName

serializedName: string = "date"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

errorCode

errorCode: object

serializedName

serializedName: string = "x-ms-error-code"

type

type: object

name

name: "String" = "String"

requestId

requestId: object

serializedName

serializedName: string = "x-ms-request-id"

type

type: object

name

name: "String" = "String"

version

version: object

serializedName

serializedName: string = "x-ms-version"

type

type: object

name

name: "String" = "String"

Const BlobAcquireLeaseHeaders

BlobAcquireLeaseHeaders: object

Defines headers for AcquireLease operation.

Optional clientRequestId

clientRequestId: undefined | string

If a client request id header is sent in the request, this header will be present in the response with the same value.

Optional date

date: Date

UTC date/time value generated by the service that indicates the time at which the response was initiated

Optional eTag

eTag: undefined | string

The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes.

Optional errorCode

errorCode: undefined | string

Optional lastModified

lastModified: Date

Returns the date and time the blob was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob.

Optional leaseId

leaseId: undefined | string

Uniquely identifies a blobs's lease

Optional requestId

requestId: undefined | string

This header uniquely identifies the request that was made and can be used for troubleshooting the request.

Optional version

version: undefined | string

Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above.

serializedName

serializedName: string = "blob-acquirelease-headers"

type

type: object

className

className: string = "BlobAcquireLeaseHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "x-ms-client-request-id"

type

type: object

name

name: "String" = "String"

date

date: object

serializedName

serializedName: string = "date"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

errorCode

errorCode: object

serializedName

serializedName: string = "x-ms-error-code"

type

type: object

name

name: "String" = "String"

lastModified

lastModified: object

serializedName

serializedName: string = "last-modified"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

leaseId

leaseId: object

serializedName

serializedName: string = "x-ms-lease-id"

type

type: object

name

name: "String" = "String"

requestId

requestId: object

serializedName

serializedName: string = "x-ms-request-id"

type

type: object

name

name: "String" = "String"

version

version: object

serializedName

serializedName: string = "x-ms-version"

type

type: object

name

name: "String" = "String"

Const BlobBreakLeaseHeaders

BlobBreakLeaseHeaders: object

Defines headers for BreakLease operation.

Optional clientRequestId

clientRequestId: undefined | string

If a client request id header is sent in the request, this header will be present in the response with the same value.

Optional date

date: Date

UTC date/time value generated by the service that indicates the time at which the response was initiated

Optional eTag

eTag: undefined | string

The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes.

Optional errorCode

errorCode: undefined | string

Optional lastModified

lastModified: Date

Returns the date and time the blob was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob.

Optional leaseTime

leaseTime: undefined | number

Approximate time remaining in the lease period, in seconds.

Optional requestId

requestId: undefined | string

This header uniquely identifies the request that was made and can be used for troubleshooting the request.

Optional version

version: undefined | string

Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above.

serializedName

serializedName: string = "blob-breaklease-headers"

type

type: object

className

className: string = "BlobBreakLeaseHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "x-ms-client-request-id"

type

type: object

name

name: "String" = "String"

date

date: object

serializedName

serializedName: string = "date"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

errorCode

errorCode: object

serializedName

serializedName: string = "x-ms-error-code"

type

type: object

name

name: "String" = "String"

lastModified

lastModified: object

serializedName

serializedName: string = "last-modified"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

leaseTime

leaseTime: object

serializedName

serializedName: string = "x-ms-lease-time"

type

type: object

name

name: "Number" = "Number"

requestId

requestId: object

serializedName

serializedName: string = "x-ms-request-id"

type

type: object

name

name: "String" = "String"

version

version: object

serializedName

serializedName: string = "x-ms-version"

type

type: object

name

name: "String" = "String"

Const BlobChangeLeaseHeaders

BlobChangeLeaseHeaders: object

Defines headers for ChangeLease operation.

Optional clientRequestId

clientRequestId: undefined | string

If a client request id header is sent in the request, this header will be present in the response with the same value.

Optional date

date: Date

UTC date/time value generated by the service that indicates the time at which the response was initiated

Optional eTag

eTag: undefined | string

The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes.

Optional errorCode

errorCode: undefined | string

Optional lastModified

lastModified: Date

Returns the date and time the blob was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob.

Optional leaseId

leaseId: undefined | string

Uniquely identifies a blobs's lease

Optional requestId

requestId: undefined | string

This header uniquely identifies the request that was made and can be used for troubleshooting the request.

Optional version

version: undefined | string

Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above.

serializedName

serializedName: string = "blob-changelease-headers"

type

type: object

className

className: string = "BlobChangeLeaseHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "x-ms-client-request-id"

type

type: object

name

name: "String" = "String"

date

date: object

serializedName

serializedName: string = "date"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

errorCode

errorCode: object

serializedName

serializedName: string = "x-ms-error-code"

type

type: object

name

name: "String" = "String"

lastModified

lastModified: object

serializedName

serializedName: string = "last-modified"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

leaseId

leaseId: object

serializedName

serializedName: string = "x-ms-lease-id"

type

type: object

name

name: "String" = "String"

requestId

requestId: object

serializedName

serializedName: string = "x-ms-request-id"

type

type: object

name

name: "String" = "String"

version

version: object

serializedName

serializedName: string = "x-ms-version"

type

type: object

name

name: "String" = "String"

Const BlobCopyFromURLHeaders

BlobCopyFromURLHeaders: object

Defines headers for CopyFromURL operation.

Optional clientRequestId

clientRequestId: undefined | string

If a client request id header is sent in the request, this header will be present in the response with the same value.

Optional copyId

copyId: undefined | string

String identifier for this copy operation.

Optional copyStatus

copyStatus: SyncCopyStatusType

State of the copy operation identified by x-ms-copy-id. Possible values include: 'success'

Optional date

date: Date

UTC date/time value generated by the service that indicates the time at which the response was initiated

Optional eTag

eTag: undefined | string

The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes.

Optional errorCode

errorCode: undefined | string

Optional lastModified

lastModified: Date

Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob.

Optional requestId

requestId: undefined | string

This header uniquely identifies the request that was made and can be used for troubleshooting the request.

Optional version

version: undefined | string

Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above.

serializedName

serializedName: string = "blob-copyfromurl-headers"

type

type: object

className

className: string = "BlobCopyFromURLHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "x-ms-client-request-id"

type

type: object

name

name: "String" = "String"

copyId

copyId: object

serializedName

serializedName: string = "x-ms-copy-id"

type

type: object

name

name: "String" = "String"

copyStatus

copyStatus: object

serializedName

serializedName: string = "x-ms-copy-status"

type

type: object

allowedValues

allowedValues: string[] = ["success"]

name

name: "Enum" = "Enum"

date

date: object

serializedName

serializedName: string = "date"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

errorCode

errorCode: object

serializedName

serializedName: string = "x-ms-error-code"

type

type: object

name

name: "String" = "String"

lastModified

lastModified: object

serializedName

serializedName: string = "last-modified"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

requestId

requestId: object

serializedName

serializedName: string = "x-ms-request-id"

type

type: object

name

name: "String" = "String"

version

version: object

serializedName

serializedName: string = "x-ms-version"

type

type: object

name

name: "String" = "String"

Const BlobCreateSnapshotHeaders

BlobCreateSnapshotHeaders: object

Defines headers for CreateSnapshot operation.

Optional clientRequestId

clientRequestId: undefined | string

If a client request id header is sent in the request, this header will be present in the response with the same value.

Optional date

date: Date

UTC date/time value generated by the service that indicates the time at which the response was initiated

Optional eTag

eTag: undefined | string

The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes.

Optional encryptionKeySha256

encryptionKeySha256: undefined | string

The SHA-256 hash of the encryption key used to encrypt the source blob. This header is only returned when the blob was encrypted with a customer-provided key.

Optional errorCode

errorCode: undefined | string

Optional isServerEncrypted

isServerEncrypted: undefined | false | true

True if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise. For a snapshot request, this header is set to true when metadata was provided in the request and encrypted with a customer-provided key.

Optional lastModified

lastModified: Date

Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob.

Optional requestId

requestId: undefined | string

This header uniquely identifies the request that was made and can be used for troubleshooting the request.

Optional snapshot

snapshot: undefined | string

Uniquely identifies the snapshot and indicates the snapshot version. It may be used in subsequent requests to access the snapshot

Optional version

version: undefined | string

Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above.

serializedName

serializedName: string = "blob-createsnapshot-headers"

type

type: object

className

className: string = "BlobCreateSnapshotHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "x-ms-client-request-id"

type

type: object

name

name: "String" = "String"

date

date: object

serializedName

serializedName: string = "date"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

encryptionKeySha256

encryptionKeySha256: object

serializedName

serializedName: string = "x-ms-encryption-key-sha256"

type

type: object

name

name: "String" = "String"

errorCode

errorCode: object

serializedName

serializedName: string = "x-ms-error-code"

type

type: object

name

name: "String" = "String"

isServerEncrypted

isServerEncrypted: object

serializedName

serializedName: string = "x-ms-request-server-encrypted"

type

type: object

name

name: "Boolean" = "Boolean"

lastModified

lastModified: object

serializedName

serializedName: string = "last-modified"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

requestId

requestId: object

serializedName

serializedName: string = "x-ms-request-id"

type

type: object

name

name: "String" = "String"

snapshot

snapshot: object

serializedName

serializedName: string = "x-ms-snapshot"

type

type: object

name

name: "String" = "String"

version

version: object

serializedName

serializedName: string = "x-ms-version"

type

type: object

name

name: "String" = "String"

Const BlobDeleteHeaders

BlobDeleteHeaders: object

Defines headers for Delete operation.

Optional clientRequestId

clientRequestId: undefined | string

If a client request id header is sent in the request, this header will be present in the response with the same value.

Optional date

date: Date

UTC date/time value generated by the service that indicates the time at which the response was initiated

Optional errorCode

errorCode: undefined | string

Optional requestId

requestId: undefined | string

This header uniquely identifies the request that was made and can be used for troubleshooting the request.

Optional version

version: undefined | string

Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above.

serializedName

serializedName: string = "blob-delete-headers"

type

type: object

className

className: string = "BlobDeleteHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "x-ms-client-request-id"

type

type: object

name

name: "String" = "String"

date

date: object

serializedName

serializedName: string = "date"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

errorCode

errorCode: object

serializedName

serializedName: string = "x-ms-error-code"

type

type: object

name

name: "String" = "String"

requestId

requestId: object

serializedName

serializedName: string = "x-ms-request-id"

type

type: object

name

name: "String" = "String"

version

version: object

serializedName

serializedName: string = "x-ms-version"

type

type: object

name

name: "String" = "String"

Const BlobDownloadHeaders

BlobDownloadHeaders: object

Defines headers for Download operation.

Optional acceptRanges

acceptRanges: undefined | string

Indicates that the service supports requests for partial blob content.

Optional blobCommittedBlockCount

blobCommittedBlockCount: undefined | number

The number of committed blocks present in the blob. This header is returned only for append blobs.

Optional blobContentMD5

blobContentMD5: Uint8Array

If the blob has a MD5 hash, and if request contains range header (Range or x-ms-range), this response header is returned with the value of the whole blob's MD5 value. This value may or may not be equal to the value returned in Content-MD5 header, with the latter calculated from the requested range

Optional blobSequenceNumber

blobSequenceNumber: undefined | number

The current sequence number for a page blob. This header is not returned for block blobs or append blobs

Optional blobType

blobType: BlobType

The blob's type. Possible values include: 'BlockBlob', 'PageBlob', 'AppendBlob'

Optional cacheControl

cacheControl: undefined | string

This header is returned if it was previously specified for the blob.

Optional clientRequestId

clientRequestId: undefined | string

If a client request id header is sent in the request, this header will be present in the response with the same value.

Optional contentCrc64

contentCrc64: Uint8Array

If the request is to read a specified range and the x-ms-range-get-content-crc64 is set to true, then the request returns a crc64 for the range, as long as the range size is less than or equal to 4 MB. If both x-ms-range-get-content-crc64 & x-ms-range-get-content-md5 is specified in the same request, it will fail with 400(Bad Request)

Optional contentDisposition

contentDisposition: undefined | string

This header returns the value that was specified for the 'x-ms-blob-content-disposition' header. The Content-Disposition response header field conveys additional information about how to process the response payload, and also can be used to attach additional metadata. For example, if set to attachment, it indicates that the user-agent should not display the response, but instead show a Save As dialog with a filename other than the blob name specified.

Optional contentEncoding

contentEncoding: undefined | string

This header returns the value that was specified for the Content-Encoding request header

Optional contentLanguage

contentLanguage: undefined | string

This header returns the value that was specified for the Content-Language request header.

Optional contentLength

contentLength: undefined | number

The number of bytes present in the response body.

Optional contentMD5

contentMD5: Uint8Array

If the blob has an MD5 hash and this operation is to read the full blob, this response header is returned so that the client can check for message content integrity.

Optional contentRange

contentRange: undefined | string

Indicates the range of bytes returned in the event that the client requested a subset of the blob by setting the 'Range' request header.

Optional contentType

contentType: undefined | string

The media type of the body of the response. For Download Blob this is 'application/octet-stream'

Optional copyCompletionTime

copyCompletionTime: Date

Conclusion time of the last attempted Copy Blob operation where this blob was the destination blob. This value can specify the time of a completed, aborted, or failed copy attempt. This header does not appear if a copy is pending, if this blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List.

Optional copyId

copyId: undefined | string

String identifier for this copy operation. Use with Get Blob Properties to check the status of this copy operation, or pass to Abort Copy Blob to abort a pending copy.

Optional copyProgress

copyProgress: undefined | string

Contains the number of bytes copied and the total bytes in the source in the last attempted Copy Blob operation where this blob was the destination blob. Can show between 0 and Content-Length bytes copied. This header does not appear if this blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List

Optional copySource

copySource: undefined | string

URL up to 2 KB in length that specifies the source blob or file used in the last attempted Copy Blob operation where this blob was the destination blob. This header does not appear if this blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List.

Optional copyStatus

copyStatus: CopyStatusType

State of the copy operation identified by x-ms-copy-id. Possible values include: 'pending', 'success', 'aborted', 'failed'

Optional copyStatusDescription

copyStatusDescription: undefined | string

Only appears when x-ms-copy-status is failed or pending. Describes the cause of the last fatal or non-fatal copy operation failure. This header does not appear if this blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List

Optional date

date: Date

UTC date/time value generated by the service that indicates the time at which the response was initiated

Optional eTag

eTag: undefined | string

The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes.

Optional encryptionKeySha256

encryptionKeySha256: undefined | string

The SHA-256 hash of the encryption key used to encrypt the blob. This header is only returned when the blob was encrypted with a customer-provided key.

Optional errorCode

errorCode: undefined | string

Optional isServerEncrypted

isServerEncrypted: undefined | false | true

The value of this header is set to true if the blob data and application metadata are completely encrypted using the specified algorithm. Otherwise, the value is set to false (when the blob is unencrypted, or if only parts of the blob/application metadata are encrypted).

Optional lastModified

lastModified: Date

Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob.

Optional leaseDuration

leaseDuration: LeaseDurationType

When a blob is leased, specifies whether the lease is of infinite or fixed duration. Possible values include: 'infinite', 'fixed'

Optional leaseState

leaseState: LeaseStateType

Lease state of the blob. Possible values include: 'available', 'leased', 'expired', 'breaking', 'broken'

Optional leaseStatus

leaseStatus: LeaseStatusType

The current lease status of the blob. Possible values include: 'locked', 'unlocked'

Optional metadata

metadata: undefined | object

Optional requestId

requestId: undefined | string

This header uniquely identifies the request that was made and can be used for troubleshooting the request.

Optional version

version: undefined | string

Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above.

serializedName

serializedName: string = "blob-download-headers"

type

type: object

className

className: string = "BlobDownloadHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

acceptRanges

acceptRanges: object

serializedName

serializedName: string = "accept-ranges"

type

type: object

name

name: "String" = "String"

blobCommittedBlockCount

blobCommittedBlockCount: object

serializedName

serializedName: string = "x-ms-blob-committed-block-count"

type

type: object

name

name: "Number" = "Number"

blobContentMD5

blobContentMD5: object

serializedName

serializedName: string = "x-ms-blob-content-md5"

type

type: object

name

name: "ByteArray" = "ByteArray"

blobSequenceNumber

blobSequenceNumber: object

serializedName

serializedName: string = "x-ms-blob-sequence-number"

type

type: object

name

name: "Number" = "Number"

blobType

blobType: object

serializedName

serializedName: string = "x-ms-blob-type"

type

type: object

allowedValues

allowedValues: string[] = ["BlockBlob","PageBlob","AppendBlob"]

name

name: "Enum" = "Enum"

cacheControl

cacheControl: object

serializedName

serializedName: string = "cache-control"

type

type: object

name

name: "String" = "String"

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "x-ms-client-request-id"

type

type: object

name

name: "String" = "String"

contentCrc64

contentCrc64: object

serializedName

serializedName: string = "x-ms-content-crc64"

type

type: object

name

name: "ByteArray" = "ByteArray"

contentDisposition

contentDisposition: object

serializedName

serializedName: string = "content-disposition"

type

type: object

name

name: "String" = "String"

contentEncoding

contentEncoding: object

serializedName

serializedName: string = "content-encoding"

type

type: object

name

name: "String" = "String"

contentLanguage

contentLanguage: object

serializedName

serializedName: string = "content-language"

type

type: object

name

name: "String" = "String"

contentLength

contentLength: object

serializedName

serializedName: string = "content-length"

type

type: object

name

name: "Number" = "Number"

contentMD5

contentMD5: object

serializedName

serializedName: string = "content-md5"

type

type: object

name

name: "ByteArray" = "ByteArray"

contentRange

contentRange: object

serializedName

serializedName: string = "content-range"

type

type: object

name

name: "String" = "String"

contentType

contentType: object

serializedName

serializedName: string = "content-type"

type

type: object

name

name: "String" = "String"

copyCompletionTime

copyCompletionTime: object

serializedName

serializedName: string = "x-ms-copy-completion-time"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

copyId

copyId: object

serializedName

serializedName: string = "x-ms-copy-id"

type

type: object

name

name: "String" = "String"

copyProgress

copyProgress: object

serializedName

serializedName: string = "x-ms-copy-progress"

type

type: object

name

name: "String" = "String"

copySource

copySource: object

serializedName

serializedName: string = "x-ms-copy-source"

type

type: object

name

name: "String" = "String"

copyStatus

copyStatus: object

serializedName

serializedName: string = "x-ms-copy-status"

type

type: object

allowedValues

allowedValues: string[] = ["pending","success","aborted","failed"]

name

name: "Enum" = "Enum"

copyStatusDescription

copyStatusDescription: object

serializedName

serializedName: string = "x-ms-copy-status-description"

type

type: object

name

name: "String" = "String"

date

date: object

serializedName

serializedName: string = "date"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

encryptionKeySha256

encryptionKeySha256: object

serializedName

serializedName: string = "x-ms-encryption-key-sha256"

type

type: object

name

name: "String" = "String"

errorCode

errorCode: object

serializedName

serializedName: string = "x-ms-error-code"

type

type: object

name

name: "String" = "String"

isServerEncrypted

isServerEncrypted: object

serializedName

serializedName: string = "x-ms-server-encrypted"

type

type: object

name

name: "Boolean" = "Boolean"

lastModified

lastModified: object

serializedName

serializedName: string = "last-modified"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

leaseDuration

leaseDuration: object

serializedName

serializedName: string = "x-ms-lease-duration"

type

type: object

allowedValues

allowedValues: string[] = ["infinite","fixed"]

name

name: "Enum" = "Enum"

leaseState

leaseState: object

serializedName

serializedName: string = "x-ms-lease-state"

type

type: object

allowedValues

allowedValues: string[] = ["available","leased","expired","breaking","broken"]

name

name: "Enum" = "Enum"

leaseStatus

leaseStatus: object

serializedName

serializedName: string = "x-ms-lease-status"

type

type: object

allowedValues

allowedValues: string[] = ["locked","unlocked"]

name

name: "Enum" = "Enum"

metadata

metadata: object

headerCollectionPrefix

headerCollectionPrefix: string = "x-ms-meta-"

serializedName

serializedName: string = "x-ms-meta"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "String" = "String"

requestId

requestId: object

serializedName

serializedName: string = "x-ms-request-id"

type

type: object

name

name: "String" = "String"

version

version: object

serializedName

serializedName: string = "x-ms-version"

type

type: object

name

name: "String" = "String"

Const BlobFlatListSegment

BlobFlatListSegment: object

An interface representing BlobFlatListSegment.

blobItems

blobItems: BlobItem[]

serializedName

serializedName: string = "BlobFlatListSegment"

xmlName

xmlName: string = "Blobs"

type

type: object

className

className: string = "BlobFlatListSegment"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

blobItems

blobItems: object

required

required: true = true

serializedName

serializedName: string = "BlobItems"

xmlElementName

xmlElementName: string = "Blob"

xmlName

xmlName: string = "BlobItems"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "BlobItem"

name

name: "Composite" = "Composite"

Const BlobGetAccessControlHeaders

BlobGetAccessControlHeaders: object

Defines headers for GetAccessControl operation.

Optional clientRequestId

clientRequestId: undefined | string

If a client request id header is sent in the request, this header will be present in the response with the same value.

Optional date

date: Date

A UTC date/time value generated by the service that indicates the time at which the response was initiated.

Optional eTag

eTag: undefined | string

An HTTP entity tag associated with the file or directory.

Optional lastModified

lastModified: Date

The data and time the file or directory was last modified. Write operations on the file or directory update the last modified time.

Optional requestId

requestId: undefined | string

A server-generated UUID recorded in the analytics logs for troubleshooting and correlation.

Optional version

version: undefined | string

The version of the REST protocol used to process the request.

Optional xMsAcl

xMsAcl: undefined | string

The POSIX access control list for the file or directory. Included in the response only if the action is "getAccessControl" and Hierarchical Namespace is enabled for the account.

Optional xMsGroup

xMsGroup: undefined | string

The owning group of the file or directory. Included in the response if Hierarchical Namespace is enabled for the account.

Optional xMsOwner

xMsOwner: undefined | string

The owner of the file or directory. Included in the response if Hierarchical Namespace is enabled for the account.

Optional xMsPermissions

xMsPermissions: undefined | string

The POSIX access permissions for the file owner, the file owning group, and others. Included in the response if Hierarchical Namespace is enabled for the account.

serializedName

serializedName: string = "blob-getaccesscontrol-headers"

type

type: object

className

className: string = "BlobGetAccessControlHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "x-ms-client-request-id"

type

type: object

name

name: "String" = "String"

date

date: object

serializedName

serializedName: string = "date"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

lastModified

lastModified: object

serializedName

serializedName: string = "last-modified"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

requestId

requestId: object

serializedName

serializedName: string = "x-ms-request-id"

type

type: object

name

name: "String" = "String"

version

version: object

serializedName

serializedName: string = "x-ms-version"

type

type: object

name

name: "String" = "String"

xMsAcl

xMsAcl: object

serializedName

serializedName: string = "x-ms-acl"

type

type: object

name

name: "String" = "String"

xMsGroup

xMsGroup: object

serializedName

serializedName: string = "x-ms-group"

type

type: object

name

name: "String" = "String"

xMsOwner

xMsOwner: object

serializedName

serializedName: string = "x-ms-owner"

type

type: object

name

name: "String" = "String"

xMsPermissions

xMsPermissions: object

serializedName

serializedName: string = "x-ms-permissions"

type

type: object

name

name: "String" = "String"

Const BlobGetAccountInfoHeaders

BlobGetAccountInfoHeaders: object

Defines headers for GetAccountInfo operation.

Optional accountKind

accountKind: AccountKind

Identifies the account kind. Possible values include: 'Storage', 'BlobStorage', 'StorageV2'

Optional clientRequestId

clientRequestId: undefined | string

If a client request id header is sent in the request, this header will be present in the response with the same value.

Optional date

date: Date

UTC date/time value generated by the service that indicates the time at which the response was initiated

Optional errorCode

errorCode: undefined | string

Optional requestId

requestId: undefined | string

This header uniquely identifies the request that was made and can be used for troubleshooting the request.

Optional skuName

skuName: SkuName

Identifies the sku name of the account. Possible values include: 'Standard_LRS', 'Standard_GRS', 'Standard_RAGRS', 'Standard_ZRS', 'Premium_LRS'

Optional version

version: undefined | string

Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above.

serializedName

serializedName: string = "blob-getaccountinfo-headers"

type

type: object

className

className: string = "BlobGetAccountInfoHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

accountKind

accountKind: object

serializedName

serializedName: string = "x-ms-account-kind"

type

type: object

allowedValues

allowedValues: string[] = ["Storage","BlobStorage","StorageV2"]

name

name: "Enum" = "Enum"

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "x-ms-client-request-id"

type

type: object

name

name: "String" = "String"

date

date: object

serializedName

serializedName: string = "date"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

errorCode

errorCode: object

serializedName

serializedName: string = "x-ms-error-code"

type

type: object

name

name: "String" = "String"

requestId

requestId: object

serializedName

serializedName: string = "x-ms-request-id"

type

type: object

name

name: "String" = "String"

skuName

skuName: object

serializedName

serializedName: string = "x-ms-sku-name"

type

type: object

allowedValues

allowedValues: string[] = ["Standard_LRS","Standard_GRS","Standard_RAGRS","Standard_ZRS","Premium_LRS"]

name

name: "Enum" = "Enum"

version

version: object

serializedName

serializedName: string = "x-ms-version"

type

type: object

name

name: "String" = "String"

Const BlobGetPropertiesHeaders

BlobGetPropertiesHeaders: object

Defines headers for GetProperties operation.

Optional acceptRanges

acceptRanges: undefined | string

Indicates that the service supports requests for partial blob content.

Optional accessTier

accessTier: undefined | string

The tier of page blob on a premium storage account or tier of block blob on blob storage LRS accounts. For a list of allowed premium page blob tiers, see https://docs.microsoft.com/en-us/azure/virtual-machines/windows/premium-storage#features. For blob storage LRS accounts, valid values are Hot/Cool/Archive.

Optional accessTierChangeTime

accessTierChangeTime: Date

The time the tier was changed on the object. This is only returned if the tier on the block blob was ever set.

Optional accessTierInferred

accessTierInferred: undefined | false | true

For page blobs on a premium storage account only. If the access tier is not explicitly set on the blob, the tier is inferred based on its content length and this header will be returned with true value.

Optional archiveStatus

archiveStatus: undefined | string

For blob storage LRS accounts, valid values are rehydrate-pending-to-hot/rehydrate-pending-to-cool. If the blob is being rehydrated and is not complete then this header is returned indicating that rehydrate is pending and also tells the destination tier.

Optional blobCommittedBlockCount

blobCommittedBlockCount: undefined | number

The number of committed blocks present in the blob. This header is returned only for append blobs.

Optional blobSequenceNumber

blobSequenceNumber: undefined | number

The current sequence number for a page blob. This header is not returned for block blobs or append blobs

Optional blobType

blobType: BlobType

The blob's type. Possible values include: 'BlockBlob', 'PageBlob', 'AppendBlob'

Optional cacheControl

cacheControl: undefined | string

This header is returned if it was previously specified for the blob.

Optional clientRequestId

clientRequestId: undefined | string

If a client request id header is sent in the request, this header will be present in the response with the same value.

Optional contentDisposition

contentDisposition: undefined | string

This header returns the value that was specified for the 'x-ms-blob-content-disposition' header. The Content-Disposition response header field conveys additional information about how to process the response payload, and also can be used to attach additional metadata. For example, if set to attachment, it indicates that the user-agent should not display the response, but instead show a Save As dialog with a filename other than the blob name specified.

Optional contentEncoding

contentEncoding: undefined | string

This header returns the value that was specified for the Content-Encoding request header

Optional contentLanguage

contentLanguage: undefined | string

This header returns the value that was specified for the Content-Language request header.

Optional contentLength

contentLength: undefined | number

The number of bytes present in the response body.

Optional contentMD5

contentMD5: Uint8Array

If the blob has an MD5 hash and this operation is to read the full blob, this response header is returned so that the client can check for message content integrity.

Optional contentType

contentType: undefined | string

The content type specified for the blob. The default content type is 'application/octet-stream'

Optional copyCompletionTime

copyCompletionTime: Date

Conclusion time of the last attempted Copy Blob operation where this blob was the destination blob. This value can specify the time of a completed, aborted, or failed copy attempt. This header does not appear if a copy is pending, if this blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List.

Optional copyId

copyId: undefined | string

String identifier for this copy operation. Use with Get Blob Properties to check the status of this copy operation, or pass to Abort Copy Blob to abort a pending copy.

Optional copyProgress

copyProgress: undefined | string

Contains the number of bytes copied and the total bytes in the source in the last attempted Copy Blob operation where this blob was the destination blob. Can show between 0 and Content-Length bytes copied. This header does not appear if this blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List

Optional copySource

copySource: undefined | string

URL up to 2 KB in length that specifies the source blob or file used in the last attempted Copy Blob operation where this blob was the destination blob. This header does not appear if this blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List.

Optional copyStatus

copyStatus: CopyStatusType

State of the copy operation identified by x-ms-copy-id. Possible values include: 'pending', 'success', 'aborted', 'failed'

Optional copyStatusDescription

copyStatusDescription: undefined | string

Only appears when x-ms-copy-status is failed or pending. Describes the cause of the last fatal or non-fatal copy operation failure. This header does not appear if this blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List

Optional creationTime

creationTime: Date

Returns the date and time the blob was created.

Optional date

date: Date

UTC date/time value generated by the service that indicates the time at which the response was initiated

Optional destinationSnapshot

destinationSnapshot: undefined | string

Included if the blob is incremental copy blob or incremental copy snapshot, if x-ms-copy-status is success. Snapshot time of the last successful incremental copy snapshot for this blob.

Optional eTag

eTag: undefined | string

The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes.

Optional encryptionKeySha256

encryptionKeySha256: undefined | string

The SHA-256 hash of the encryption key used to encrypt the metadata. This header is only returned when the metadata was encrypted with a customer-provided key.

Optional errorCode

errorCode: undefined | string

Optional isIncrementalCopy

isIncrementalCopy: undefined | false | true

Included if the blob is incremental copy blob.

Optional isServerEncrypted

isServerEncrypted: undefined | false | true

The value of this header is set to true if the blob data and application metadata are completely encrypted using the specified algorithm. Otherwise, the value is set to false (when the blob is unencrypted, or if only parts of the blob/application metadata are encrypted).

Optional lastModified

lastModified: Date

Returns the date and time the blob was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob.

Optional leaseDuration

leaseDuration: LeaseDurationType

When a blob is leased, specifies whether the lease is of infinite or fixed duration. Possible values include: 'infinite', 'fixed'

Optional leaseState

leaseState: LeaseStateType

Lease state of the blob. Possible values include: 'available', 'leased', 'expired', 'breaking', 'broken'

Optional leaseStatus

leaseStatus: LeaseStatusType

The current lease status of the blob. Possible values include: 'locked', 'unlocked'

Optional metadata

metadata: undefined | object

Optional requestId

requestId: undefined | string

This header uniquely identifies the request that was made and can be used for troubleshooting the request.

Optional version

version: undefined | string

Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above.

serializedName

serializedName: string = "blob-getproperties-headers"

type

type: object

className

className: string = "BlobGetPropertiesHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

acceptRanges

acceptRanges: object

serializedName

serializedName: string = "accept-ranges"

type

type: object

name

name: "String" = "String"

accessTier

accessTier: object

serializedName

serializedName: string = "x-ms-access-tier"

type

type: object

name

name: "String" = "String"

accessTierChangeTime

accessTierChangeTime: object

serializedName

serializedName: string = "x-ms-access-tier-change-time"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

accessTierInferred

accessTierInferred: object

serializedName

serializedName: string = "x-ms-access-tier-inferred"

type

type: object

name

name: "Boolean" = "Boolean"

archiveStatus

archiveStatus: object

serializedName

serializedName: string = "x-ms-archive-status"

type

type: object

name

name: "String" = "String"

blobCommittedBlockCount

blobCommittedBlockCount: object

serializedName

serializedName: string = "x-ms-blob-committed-block-count"

type

type: object

name

name: "Number" = "Number"

blobSequenceNumber

blobSequenceNumber: object

serializedName

serializedName: string = "x-ms-blob-sequence-number"

type

type: object

name

name: "Number" = "Number"

blobType

blobType: object

serializedName

serializedName: string = "x-ms-blob-type"

type

type: object

allowedValues

allowedValues: string[] = ["BlockBlob","PageBlob","AppendBlob"]

name

name: "Enum" = "Enum"

cacheControl

cacheControl: object

serializedName

serializedName: string = "cache-control"

type

type: object

name

name: "String" = "String"

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "x-ms-client-request-id"

type

type: object

name

name: "String" = "String"

contentDisposition

contentDisposition: object

serializedName

serializedName: string = "content-disposition"

type

type: object

name

name: "String" = "String"

contentEncoding

contentEncoding: object

serializedName

serializedName: string = "content-encoding"

type

type: object

name

name: "String" = "String"

contentLanguage

contentLanguage: object

serializedName

serializedName: string = "content-language"

type

type: object

name

name: "String" = "String"

contentLength

contentLength: object

serializedName

serializedName: string = "content-length"

type

type: object

name

name: "Number" = "Number"

contentMD5

contentMD5: object

serializedName

serializedName: string = "content-md5"

type

type: object

name

name: "ByteArray" = "ByteArray"

contentType

contentType: object

serializedName

serializedName: string = "content-type"

type

type: object

name

name: "String" = "String"

copyCompletionTime

copyCompletionTime: object

serializedName

serializedName: string = "x-ms-copy-completion-time"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

copyId

copyId: object

serializedName

serializedName: string = "x-ms-copy-id"

type

type: object

name

name: "String" = "String"

copyProgress

copyProgress: object

serializedName

serializedName: string = "x-ms-copy-progress"

type

type: object

name

name: "String" = "String"

copySource

copySource: object

serializedName

serializedName: string = "x-ms-copy-source"

type

type: object

name

name: "String" = "String"

copyStatus

copyStatus: object

serializedName

serializedName: string = "x-ms-copy-status"

type

type: object

allowedValues

allowedValues: string[] = ["pending","success","aborted","failed"]

name

name: "Enum" = "Enum"

copyStatusDescription

copyStatusDescription: object

serializedName

serializedName: string = "x-ms-copy-status-description"

type

type: object

name

name: "String" = "String"

creationTime

creationTime: object

serializedName

serializedName: string = "x-ms-creation-time"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

date

date: object

serializedName

serializedName: string = "date"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

destinationSnapshot

destinationSnapshot: object

serializedName

serializedName: string = "x-ms-copy-destination-snapshot"

type

type: object

name

name: "String" = "String"

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

encryptionKeySha256

encryptionKeySha256: object

serializedName

serializedName: string = "x-ms-encryption-key-sha256"

type

type: object

name

name: "String" = "String"

errorCode

errorCode: object

serializedName

serializedName: string = "x-ms-error-code"

type

type: object

name

name: "String" = "String"

isIncrementalCopy

isIncrementalCopy: object

serializedName

serializedName: string = "x-ms-incremental-copy"

type

type: object

name

name: "Boolean" = "Boolean"

isServerEncrypted

isServerEncrypted: object

serializedName

serializedName: string = "x-ms-server-encrypted"

type

type: object

name

name: "Boolean" = "Boolean"

lastModified

lastModified: object

serializedName

serializedName: string = "last-modified"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

leaseDuration

leaseDuration: object

serializedName

serializedName: string = "x-ms-lease-duration"

type

type: object

allowedValues

allowedValues: string[] = ["infinite","fixed"]

name

name: "Enum" = "Enum"

leaseState

leaseState: object

serializedName

serializedName: string = "x-ms-lease-state"

type

type: object

allowedValues

allowedValues: string[] = ["available","leased","expired","breaking","broken"]

name

name: "Enum" = "Enum"

leaseStatus

leaseStatus: object

serializedName

serializedName: string = "x-ms-lease-status"

type

type: object

allowedValues

allowedValues: string[] = ["locked","unlocked"]

name

name: "Enum" = "Enum"

metadata

metadata: object

headerCollectionPrefix

headerCollectionPrefix: string = "x-ms-meta-"

serializedName

serializedName: string = "x-ms-meta"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "String" = "String"

requestId

requestId: object

serializedName

serializedName: string = "x-ms-request-id"

type

type: object

name

name: "String" = "String"

version

version: object

serializedName

serializedName: string = "x-ms-version"

type

type: object

name

name: "String" = "String"

Const BlobHTTPHeaders

BlobHTTPHeaders: object

Additional parameters for a set of operations.

Optional blobCacheControl

blobCacheControl: undefined | string

Optional. Sets the blob's cache control. If specified, this property is stored with the blob and returned with a read request.

Optional blobContentDisposition

blobContentDisposition: undefined | string

Optional. Sets the blob's Content-Disposition header.

Optional blobContentEncoding

blobContentEncoding: undefined | string

Optional. Sets the blob's content encoding. If specified, this property is stored with the blob and returned with a read request.

Optional blobContentLanguage

blobContentLanguage: undefined | string

Optional. Set the blob's content language. If specified, this property is stored with the blob and returned with a read request.

Optional blobContentMD5

blobContentMD5: Uint8Array

Optional. An MD5 hash of the blob content. Note that this hash is not validated, as the hashes for the individual blocks were validated when each was uploaded.

Optional blobContentType

blobContentType: undefined | string

Optional. Sets the blob's content type. If specified, this property is stored with the blob and returned with a read request.

xmlName

xmlName: string = "blob-HTTP-headers"

type

type: object

className

className: string = "BlobHTTPHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

blobCacheControl

blobCacheControl: object

xmlName

xmlName: string = "blobCacheControl"

type

type: object

name

name: "String" = "String"

blobContentDisposition

blobContentDisposition: object

xmlName

xmlName: string = "blobContentDisposition"

type

type: object

name

name: "String" = "String"

blobContentEncoding

blobContentEncoding: object

xmlName

xmlName: string = "blobContentEncoding"

type

type: object

name

name: "String" = "String"

blobContentLanguage

blobContentLanguage: object

xmlName

xmlName: string = "blobContentLanguage"

type

type: object

name

name: "String" = "String"

blobContentMD5

blobContentMD5: object

xmlName

xmlName: string = "blobContentMD5"

type

type: object

name

name: "ByteArray" = "ByteArray"

blobContentType

blobContentType: object

xmlName

xmlName: string = "blobContentType"

type

type: object

name

name: "String" = "String"

Const BlobHierarchyListSegment

BlobHierarchyListSegment: object

An interface representing BlobHierarchyListSegment.

blobItems

blobItems: BlobItem[]

Optional blobPrefixes

blobPrefixes: BlobPrefix[]

serializedName

serializedName: string = "BlobHierarchyListSegment"

xmlName

xmlName: string = "Blobs"

type

type: object

className

className: string = "BlobHierarchyListSegment"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

blobItems

blobItems: object

required

required: true = true

serializedName

serializedName: string = "BlobItems"

xmlElementName

xmlElementName: string = "Blob"

xmlName

xmlName: string = "BlobItems"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "BlobItem"

name

name: "Composite" = "Composite"

blobPrefixes

blobPrefixes: object

serializedName

serializedName: string = "BlobPrefixes"

xmlElementName

xmlElementName: string = "BlobPrefix"

xmlName

xmlName: string = "BlobPrefixes"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "BlobPrefix"

name

name: "Composite" = "Composite"

Const BlobItem

BlobItem: object

An Azure Storage blob

deleted

deleted: boolean

Optional metadata

metadata: BlobMetadata

name

name: string

properties

properties: BlobProperties

snapshot

snapshot: string

serializedName

serializedName: string = "BlobItem"

xmlName

xmlName: string = "Blob"

type

type: object

className

className: string = "BlobItem"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

deleted

deleted: object

required

required: true = true

serializedName

serializedName: string = "Deleted"

xmlName

xmlName: string = "Deleted"

type

type: object

name

name: "Boolean" = "Boolean"

metadata

metadata: object

serializedName

serializedName: string = "Metadata"

xmlName

xmlName: string = "Metadata"

type

type: object

className

className: string = "BlobMetadata"

name

name: "Composite" = "Composite"

additionalProperties

additionalProperties: object

type

type: object

name

name: "String" = "String"

name

name: object

required

required: true = true

serializedName

serializedName: string = "Name"

xmlName

xmlName: string = "Name"

type

type: object

name

name: "String" = "String"

properties

properties: object

required

required: true = true

serializedName

serializedName: string = "Properties"

xmlName

xmlName: string = "Properties"

type

type: object

className

className: string = "BlobProperties"

name

name: "Composite" = "Composite"

snapshot

snapshot: object

required

required: true = true

serializedName

serializedName: string = "Snapshot"

xmlName

xmlName: string = "Snapshot"

type

type: object

name

name: "String" = "String"

Const BlobMetadata

BlobMetadata: object

An interface representing BlobMetadata.

Optional encrypted

encrypted: undefined | string

serializedName

serializedName: string = "BlobMetadata"

xmlName

xmlName: string = "Metadata"

type

type: object

className

className: string = "BlobMetadata"

name

name: "Composite" = "Composite"

additionalProperties

additionalProperties: object

type

type: object

name

name: "String" = "String"

modelProperties

modelProperties: object

encrypted

encrypted: object

serializedName

serializedName: string = "Encrypted"

xmlIsAttribute

xmlIsAttribute: true = true

xmlName

xmlName: string = "Encrypted"

type

type: object

name

name: "String" = "String"

Const BlobPrefix

BlobPrefix: object

An interface representing BlobPrefix.

name

name: string

serializedName

serializedName: string = "BlobPrefix"

type

type: object

className

className: string = "BlobPrefix"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

name

name: object

required

required: true = true

serializedName

serializedName: string = "Name"

xmlName

xmlName: string = "Name"

type

type: object

name

name: "String" = "String"

Const BlobProperties

BlobProperties: object

Properties of a blob

Optional accessTier

accessTier: AccessTier

Possible values include: 'P4', 'P6', 'P10', 'P15', 'P20', 'P30', 'P40', 'P50', 'P60', 'P70', 'P80', 'Hot', 'Cool', 'Archive'

Optional accessTierChangeTime

accessTierChangeTime: Date

Optional accessTierInferred

accessTierInferred: undefined | false | true

Optional archiveStatus

archiveStatus: ArchiveStatus

Possible values include: 'rehydrate-pending-to-hot', 'rehydrate-pending-to-cool'

Optional blobSequenceNumber

blobSequenceNumber: undefined | number

Optional blobType

blobType: BlobType

Possible values include: 'BlockBlob', 'PageBlob', 'AppendBlob'

Optional cacheControl

cacheControl: undefined | string

Optional contentDisposition

contentDisposition: undefined | string

Optional contentEncoding

contentEncoding: undefined | string

Optional contentLanguage

contentLanguage: undefined | string

Optional contentLength

contentLength: undefined | number

Size in bytes

Optional contentMD5

contentMD5: Uint8Array

Optional contentType

contentType: undefined | string

Optional copyCompletionTime

copyCompletionTime: Date

Optional copyId

copyId: undefined | string

Optional copyProgress

copyProgress: undefined | string

Optional copySource

copySource: undefined | string

Optional copyStatus

copyStatus: CopyStatusType

Possible values include: 'pending', 'success', 'aborted', 'failed'

Optional copyStatusDescription

copyStatusDescription: undefined | string

Optional creationTime

creationTime: Date

Optional customerProvidedKeySha256

customerProvidedKeySha256: undefined | string

Optional deletedTime

deletedTime: Date

Optional destinationSnapshot

destinationSnapshot: undefined | string

etag

etag: string

Optional incrementalCopy

incrementalCopy: undefined | false | true

lastModified

lastModified: Date

Optional leaseDuration

leaseDuration: LeaseDurationType

Possible values include: 'infinite', 'fixed'

Optional leaseState

leaseState: LeaseStateType

Possible values include: 'available', 'leased', 'expired', 'breaking', 'broken'

Optional leaseStatus

leaseStatus: LeaseStatusType

Possible values include: 'locked', 'unlocked'

Optional remainingRetentionDays

remainingRetentionDays: undefined | number

Optional serverEncrypted

serverEncrypted: undefined | false | true

serializedName

serializedName: string = "BlobProperties"

xmlName

xmlName: string = "Properties"

type

type: object

className

className: string = "BlobProperties"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

accessTier

accessTier: object

serializedName

serializedName: string = "AccessTier"

xmlName

xmlName: string = "AccessTier"

type

type: object

name

name: "String" = "String"

accessTierChangeTime

accessTierChangeTime: object

serializedName

serializedName: string = "AccessTierChangeTime"

xmlName

xmlName: string = "AccessTierChangeTime"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

accessTierInferred

accessTierInferred: object

serializedName

serializedName: string = "AccessTierInferred"

xmlName

xmlName: string = "AccessTierInferred"

type

type: object

name

name: "Boolean" = "Boolean"

archiveStatus

archiveStatus: object

serializedName

serializedName: string = "ArchiveStatus"

xmlName

xmlName: string = "ArchiveStatus"

type

type: object

name

name: "String" = "String"

blobSequenceNumber

blobSequenceNumber: object

serializedName

serializedName: string = "x-ms-blob-sequence-number"

xmlName

xmlName: string = "x-ms-blob-sequence-number"

type

type: object

name

name: "Number" = "Number"

blobType

blobType: object

serializedName

serializedName: string = "BlobType"

xmlName

xmlName: string = "BlobType"

type

type: object

allowedValues

allowedValues: string[] = ["BlockBlob","PageBlob","AppendBlob"]

name

name: "Enum" = "Enum"

cacheControl

cacheControl: object

serializedName

serializedName: string = "Cache-Control"

xmlName

xmlName: string = "Cache-Control"

type

type: object

name

name: "String" = "String"

contentDisposition

contentDisposition: object

serializedName

serializedName: string = "Content-Disposition"

xmlName

xmlName: string = "Content-Disposition"

type

type: object

name

name: "String" = "String"

contentEncoding

contentEncoding: object

serializedName

serializedName: string = "Content-Encoding"

xmlName

xmlName: string = "Content-Encoding"

type

type: object

name

name: "String" = "String"

contentLanguage

contentLanguage: object

serializedName

serializedName: string = "Content-Language"

xmlName

xmlName: string = "Content-Language"

type

type: object

name

name: "String" = "String"

contentLength

contentLength: object

serializedName

serializedName: string = "Content-Length"

xmlName

xmlName: string = "Content-Length"

type

type: object

name

name: "Number" = "Number"

contentMD5

contentMD5: object

serializedName

serializedName: string = "Content-MD5"

xmlName

xmlName: string = "Content-MD5"

type

type: object

name

name: "ByteArray" = "ByteArray"

contentType

contentType: object

serializedName

serializedName: string = "Content-Type"

xmlName

xmlName: string = "Content-Type"

type

type: object

name

name: "String" = "String"

copyCompletionTime

copyCompletionTime: object

serializedName

serializedName: string = "CopyCompletionTime"

xmlName

xmlName: string = "CopyCompletionTime"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

copyId

copyId: object

serializedName

serializedName: string = "CopyId"

xmlName

xmlName: string = "CopyId"

type

type: object

name

name: "String" = "String"

copyProgress

copyProgress: object

serializedName

serializedName: string = "CopyProgress"

xmlName

xmlName: string = "CopyProgress"

type

type: object

name

name: "String" = "String"

copySource

copySource: object

serializedName

serializedName: string = "CopySource"

xmlName

xmlName: string = "CopySource"

type

type: object

name

name: "String" = "String"

copyStatus

copyStatus: object

serializedName

serializedName: string = "CopyStatus"

xmlName

xmlName: string = "CopyStatus"

type

type: object

allowedValues

allowedValues: string[] = ["pending","success","aborted","failed"]

name

name: "Enum" = "Enum"

copyStatusDescription

copyStatusDescription: object

serializedName

serializedName: string = "CopyStatusDescription"

xmlName

xmlName: string = "CopyStatusDescription"

type

type: object

name

name: "String" = "String"

creationTime

creationTime: object

serializedName

serializedName: string = "Creation-Time"

xmlName

xmlName: string = "Creation-Time"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

customerProvidedKeySha256

customerProvidedKeySha256: object

serializedName

serializedName: string = "CustomerProvidedKeySha256"

xmlName

xmlName: string = "CustomerProvidedKeySha256"

type

type: object

name

name: "String" = "String"

deletedTime

deletedTime: object

serializedName

serializedName: string = "DeletedTime"

xmlName

xmlName: string = "DeletedTime"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

destinationSnapshot

destinationSnapshot: object

serializedName

serializedName: string = "DestinationSnapshot"

xmlName

xmlName: string = "DestinationSnapshot"

type

type: object

name

name: "String" = "String"

etag

etag: object

required

required: true = true

serializedName

serializedName: string = "Etag"

xmlName

xmlName: string = "Etag"

type

type: object

name

name: "String" = "String"

incrementalCopy

incrementalCopy: object

serializedName

serializedName: string = "IncrementalCopy"

xmlName

xmlName: string = "IncrementalCopy"

type

type: object

name

name: "Boolean" = "Boolean"

lastModified

lastModified: object

required

required: true = true

serializedName

serializedName: string = "Last-Modified"

xmlName

xmlName: string = "Last-Modified"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

leaseDuration

leaseDuration: object

serializedName

serializedName: string = "LeaseDuration"

xmlName

xmlName: string = "LeaseDuration"

type

type: object

allowedValues

allowedValues: string[] = ["infinite","fixed"]

name

name: "Enum" = "Enum"

leaseState

leaseState: object

serializedName

serializedName: string = "LeaseState"

xmlName

xmlName: string = "LeaseState"

type

type: object

allowedValues

allowedValues: string[] = ["available","leased","expired","breaking","broken"]

name

name: "Enum" = "Enum"

leaseStatus

leaseStatus: object

serializedName

serializedName: string = "LeaseStatus"

xmlName

xmlName: string = "LeaseStatus"

type

type: object

allowedValues

allowedValues: string[] = ["locked","unlocked"]

name

name: "Enum" = "Enum"

remainingRetentionDays

remainingRetentionDays: object

serializedName

serializedName: string = "RemainingRetentionDays"

xmlName

xmlName: string = "RemainingRetentionDays"

type

type: object

name

name: "Number" = "Number"

serverEncrypted

serverEncrypted: object

serializedName

serializedName: string = "ServerEncrypted"

xmlName

xmlName: string = "ServerEncrypted"

type

type: object

name

name: "Boolean" = "Boolean"

Const BlobReleaseLeaseHeaders

BlobReleaseLeaseHeaders: object

Defines headers for ReleaseLease operation.

Optional clientRequestId

clientRequestId: undefined | string

If a client request id header is sent in the request, this header will be present in the response with the same value.

Optional date

date: Date

UTC date/time value generated by the service that indicates the time at which the response was initiated

Optional eTag

eTag: undefined | string

The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes.

Optional errorCode

errorCode: undefined | string

Optional lastModified

lastModified: Date

Returns the date and time the blob was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob.

Optional requestId

requestId: undefined | string

This header uniquely identifies the request that was made and can be used for troubleshooting the request.

Optional version

version: undefined | string

Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above.

serializedName

serializedName: string = "blob-releaselease-headers"

type

type: object

className

className: string = "BlobReleaseLeaseHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "x-ms-client-request-id"

type

type: object

name

name: "String" = "String"

date

date: object

serializedName

serializedName: string = "date"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

errorCode

errorCode: object

serializedName

serializedName: string = "x-ms-error-code"

type

type: object

name

name: "String" = "String"

lastModified

lastModified: object

serializedName

serializedName: string = "last-modified"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

requestId

requestId: object

serializedName

serializedName: string = "x-ms-request-id"

type

type: object

name

name: "String" = "String"

version

version: object

serializedName

serializedName: string = "x-ms-version"

type

type: object

name

name: "String" = "String"

Const BlobRenameHeaders

BlobRenameHeaders: object

Defines headers for Rename operation.

Optional clientRequestId

clientRequestId: undefined | string

If a client request id header is sent in the request, this header will be present in the response with the same value.

Optional contentLength

contentLength: undefined | number

The size of the resource in bytes.

Optional date

date: Date

A UTC date/time value generated by the service that indicates the time at which the response was initiated.

Optional eTag

eTag: undefined | string

An HTTP entity tag associated with the file or directory.

Optional lastModified

lastModified: Date

The data and time the file or directory was last modified. Write operations on the file or directory update the last modified time.

Optional requestId

requestId: undefined | string

A server-generated UUID recorded in the analytics logs for troubleshooting and correlation.

Optional version

version: undefined | string

The version of the REST protocol used to process the request.

serializedName

serializedName: string = "blob-rename-headers"

type

type: object

className

className: string = "BlobRenameHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "x-ms-client-request-id"

type

type: object

name

name: "String" = "String"

contentLength

contentLength: object

serializedName

serializedName: string = "content-length"

type

type: object

name

name: "Number" = "Number"

date

date: object

serializedName

serializedName: string = "date"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

lastModified

lastModified: object

serializedName

serializedName: string = "last-modified"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

requestId

requestId: object

serializedName

serializedName: string = "x-ms-request-id"

type

type: object

name

name: "String" = "String"

version

version: object

serializedName

serializedName: string = "x-ms-version"

type

type: object

name

name: "String" = "String"

Const BlobRenewLeaseHeaders

BlobRenewLeaseHeaders: object

Defines headers for RenewLease operation.

Optional clientRequestId

clientRequestId: undefined | string

If a client request id header is sent in the request, this header will be present in the response with the same value.

Optional date

date: Date

UTC date/time value generated by the service that indicates the time at which the response was initiated

Optional eTag

eTag: undefined | string

The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes.

Optional errorCode

errorCode: undefined | string

Optional lastModified

lastModified: Date

Returns the date and time the blob was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob.

Optional leaseId

leaseId: undefined | string

Uniquely identifies a blobs's lease

Optional requestId

requestId: undefined | string

This header uniquely identifies the request that was made and can be used for troubleshooting the request.

Optional version

version: undefined | string

Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above.

serializedName

serializedName: string = "blob-renewlease-headers"

type

type: object

className

className: string = "BlobRenewLeaseHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "x-ms-client-request-id"

type

type: object

name

name: "String" = "String"

date

date: object

serializedName

serializedName: string = "date"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

errorCode

errorCode: object

serializedName

serializedName: string = "x-ms-error-code"

type

type: object

name

name: "String" = "String"

lastModified

lastModified: object

serializedName

serializedName: string = "last-modified"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

leaseId

leaseId: object

serializedName

serializedName: string = "x-ms-lease-id"

type

type: object

name

name: "String" = "String"

requestId

requestId: object

serializedName

serializedName: string = "x-ms-request-id"

type

type: object

name

name: "String" = "String"

version

version: object

serializedName

serializedName: string = "x-ms-version"

type

type: object

name

name: "String" = "String"

Const BlobSetAccessControlHeaders

BlobSetAccessControlHeaders: object

Defines headers for SetAccessControl operation.

Optional clientRequestId

clientRequestId: undefined | string

If a client request id header is sent in the request, this header will be present in the response with the same value.

Optional date

date: Date

A UTC date/time value generated by the service that indicates the time at which the response was initiated.

Optional eTag

eTag: undefined | string

An HTTP entity tag associated with the file or directory.

Optional lastModified

lastModified: Date

The data and time the file or directory was last modified. Write operations on the file or directory update the last modified time.

Optional requestId

requestId: undefined | string

A server-generated UUID recorded in the analytics logs for troubleshooting and correlation.

Optional version

version: undefined | string

The version of the REST protocol used to process the request.

serializedName

serializedName: string = "blob-setaccesscontrol-headers"

type

type: object

className

className: string = "BlobSetAccessControlHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "x-ms-client-request-id"

type

type: object

name

name: "String" = "String"

date

date: object

serializedName

serializedName: string = "date"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

lastModified

lastModified: object

serializedName

serializedName: string = "last-modified"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

requestId

requestId: object

serializedName

serializedName: string = "x-ms-request-id"

type

type: object

name

name: "String" = "String"

version

version: object

serializedName

serializedName: string = "x-ms-version"

type

type: object

name

name: "String" = "String"

Const BlobSetHTTPHeadersHeaders

BlobSetHTTPHeadersHeaders: object

Defines headers for SetHTTPHeaders operation.

Optional blobSequenceNumber

blobSequenceNumber: undefined | number

The current sequence number for a page blob. This header is not returned for block blobs or append blobs

Optional clientRequestId

clientRequestId: undefined | string

If a client request id header is sent in the request, this header will be present in the response with the same value.

Optional date

date: Date

UTC date/time value generated by the service that indicates the time at which the response was initiated

Optional eTag

eTag: undefined | string

The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes.

Optional errorCode

errorCode: undefined | string

Optional lastModified

lastModified: Date

Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob.

Optional requestId

requestId: undefined | string

This header uniquely identifies the request that was made and can be used for troubleshooting the request.

Optional version

version: undefined | string

Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above.

serializedName

serializedName: string = "blob-sethttpheaders-headers"

type

type: object

className

className: string = "BlobSetHTTPHeadersHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

blobSequenceNumber

blobSequenceNumber: object

serializedName

serializedName: string = "x-ms-blob-sequence-number"

type

type: object

name

name: "Number" = "Number"

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "x-ms-client-request-id"

type

type: object

name

name: "String" = "String"

date

date: object

serializedName

serializedName: string = "date"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

errorCode

errorCode: object

serializedName

serializedName: string = "x-ms-error-code"

type

type: object

name

name: "String" = "String"

lastModified

lastModified: object

serializedName

serializedName: string = "last-modified"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

requestId

requestId: object

serializedName

serializedName: string = "x-ms-request-id"

type

type: object

name

name: "String" = "String"

version

version: object

serializedName

serializedName: string = "x-ms-version"

type

type: object

name

name: "String" = "String"

Const BlobSetMetadataHeaders

BlobSetMetadataHeaders: object

Defines headers for SetMetadata operation.

Optional clientRequestId

clientRequestId: undefined | string

If a client request id header is sent in the request, this header will be present in the response with the same value.

Optional date

date: Date

UTC date/time value generated by the service that indicates the time at which the response was initiated

Optional eTag

eTag: undefined | string

The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes.

Optional encryptionKeySha256

encryptionKeySha256: undefined | string

The SHA-256 hash of the encryption key used to encrypt the metadata. This header is only returned when the metadata was encrypted with a customer-provided key.

Optional errorCode

errorCode: undefined | string

Optional isServerEncrypted

isServerEncrypted: undefined | false | true

The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise.

Optional lastModified

lastModified: Date

Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob.

Optional requestId

requestId: undefined | string

This header uniquely identifies the request that was made and can be used for troubleshooting the request.

Optional version

version: undefined | string

Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above.

serializedName

serializedName: string = "blob-setmetadata-headers"

type

type: object

className

className: string = "BlobSetMetadataHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "x-ms-client-request-id"

type

type: object

name

name: "String" = "String"

date

date: object

serializedName

serializedName: string = "date"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

encryptionKeySha256

encryptionKeySha256: object

serializedName

serializedName: string = "x-ms-encryption-key-sha256"

type

type: object

name

name: "String" = "String"

errorCode

errorCode: object

serializedName

serializedName: string = "x-ms-error-code"

type

type: object

name

name: "String" = "String"

isServerEncrypted

isServerEncrypted: object

serializedName

serializedName: string = "x-ms-request-server-encrypted"

type

type: object

name

name: "Boolean" = "Boolean"

lastModified

lastModified: object

serializedName

serializedName: string = "last-modified"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

requestId

requestId: object

serializedName

serializedName: string = "x-ms-request-id"

type

type: object

name

name: "String" = "String"

version

version: object

serializedName

serializedName: string = "x-ms-version"

type

type: object

name

name: "String" = "String"

Const BlobSetTierHeaders

BlobSetTierHeaders: object

Defines headers for SetTier operation.

Optional clientRequestId

clientRequestId: undefined | string

If a client request id header is sent in the request, this header will be present in the response with the same value.

Optional errorCode

errorCode: undefined | string

Optional requestId

requestId: undefined | string

This header uniquely identifies the request that was made and can be used for troubleshooting the request.

Optional version

version: undefined | string

Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and newer.

serializedName

serializedName: string = "blob-settier-headers"

type

type: object

className

className: string = "BlobSetTierHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "x-ms-client-request-id"

type

type: object

name

name: "String" = "String"

errorCode

errorCode: object

serializedName

serializedName: string = "x-ms-error-code"

type

type: object

name

name: "String" = "String"

requestId

requestId: object

serializedName

serializedName: string = "x-ms-request-id"

type

type: object

name

name: "String" = "String"

version

version: object

serializedName

serializedName: string = "x-ms-version"

type

type: object

name

name: "String" = "String"

Const BlobStartCopyFromURLHeaders

BlobStartCopyFromURLHeaders: object

Defines headers for StartCopyFromURL operation.

Optional clientRequestId

clientRequestId: undefined | string

If a client request id header is sent in the request, this header will be present in the response with the same value.

Optional copyId

copyId: undefined | string

String identifier for this copy operation. Use with Get Blob Properties to check the status of this copy operation, or pass to Abort Copy Blob to abort a pending copy.

Optional copyStatus

copyStatus: CopyStatusType

State of the copy operation identified by x-ms-copy-id. Possible values include: 'pending', 'success', 'aborted', 'failed'

Optional date

date: Date

UTC date/time value generated by the service that indicates the time at which the response was initiated

Optional eTag

eTag: undefined | string

The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes.

Optional errorCode

errorCode: undefined | string

Optional lastModified

lastModified: Date

Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob.

Optional requestId

requestId: undefined | string

This header uniquely identifies the request that was made and can be used for troubleshooting the request.

Optional version

version: undefined | string

Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above.

serializedName

serializedName: string = "blob-startcopyfromurl-headers"

type

type: object

className

className: string = "BlobStartCopyFromURLHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "x-ms-client-request-id"

type

type: object

name

name: "String" = "String"

copyId

copyId: object

serializedName

serializedName: string = "x-ms-copy-id"

type

type: object

name

name: "String" = "String"

copyStatus

copyStatus: object

serializedName

serializedName: string = "x-ms-copy-status"

type

type: object

allowedValues

allowedValues: string[] = ["pending","success","aborted","failed"]

name

name: "Enum" = "Enum"

date

date: object

serializedName

serializedName: string = "date"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

errorCode

errorCode: object

serializedName

serializedName: string = "x-ms-error-code"

type

type: object

name

name: "String" = "String"

lastModified

lastModified: object

serializedName

serializedName: string = "last-modified"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

requestId

requestId: object

serializedName

serializedName: string = "x-ms-request-id"

type

type: object

name

name: "String" = "String"

version

version: object

serializedName

serializedName: string = "x-ms-version"

type

type: object

name

name: "String" = "String"

Const BlobUndeleteHeaders

BlobUndeleteHeaders: object

Defines headers for Undelete operation.

Optional clientRequestId

clientRequestId: undefined | string

If a client request id header is sent in the request, this header will be present in the response with the same value.

Optional date

date: Date

UTC date/time value generated by the service that indicates the time at which the response was initiated.

Optional errorCode

errorCode: undefined | string

Optional requestId

requestId: undefined | string

This header uniquely identifies the request that was made and can be used for troubleshooting the request.

Optional version

version: undefined | string

Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above.

serializedName

serializedName: string = "blob-undelete-headers"

type

type: object

className

className: string = "BlobUndeleteHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "x-ms-client-request-id"

type

type: object

name

name: "String" = "String"

date

date: object

serializedName

serializedName: string = "date"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

errorCode

errorCode: object

serializedName

serializedName: string = "x-ms-error-code"

type

type: object

name

name: "String" = "String"

requestId

requestId: object

serializedName

serializedName: string = "x-ms-request-id"

type

type: object

name

name: "String" = "String"

version

version: object

serializedName

serializedName: string = "x-ms-version"

type

type: object

name

name: "String" = "String"

Const Block

Block: object

Represents a single block in a block blob. It describes the block's ID and size.

name

name: string

The base64 encoded block ID.

size

size: number

The block size in bytes.

serializedName

serializedName: string = "Block"

type

type: object

className

className: string = "Block"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

name

name: object

required

required: true = true

serializedName

serializedName: string = "Name"

xmlName

xmlName: string = "Name"

type

type: object

name

name: "String" = "String"

size

size: object

required

required: true = true

serializedName

serializedName: string = "Size"

xmlName

xmlName: string = "Size"

type

type: object

name

name: "Number" = "Number"

Const BlockBlobCommitBlockListHeaders

BlockBlobCommitBlockListHeaders: object

Defines headers for CommitBlockList operation.

Optional clientRequestId

clientRequestId: undefined | string

If a client request id header is sent in the request, this header will be present in the response with the same value.

Optional contentMD5

contentMD5: Uint8Array

This header is returned so that the client can check for message content integrity. This header refers to the content of the request, meaning, in this case, the list of blocks, and not the content of the blob itself.

Optional date

date: Date

UTC date/time value generated by the service that indicates the time at which the response was initiated

Optional eTag

eTag: undefined | string

The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes.

Optional encryptionKeySha256

encryptionKeySha256: undefined | string

The SHA-256 hash of the encryption key used to encrypt the blob. This header is only returned when the blob was encrypted with a customer-provided key.

Optional errorCode

errorCode: undefined | string

Optional isServerEncrypted

isServerEncrypted: undefined | false | true

The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise.

Optional lastModified

lastModified: Date

Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob.

Optional requestId

requestId: undefined | string

This header uniquely identifies the request that was made and can be used for troubleshooting the request.

Optional version

version: undefined | string

Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above.

Optional xMsContentCrc64

xMsContentCrc64: Uint8Array

This header is returned so that the client can check for message content integrity. This header refers to the content of the request, meaning, in this case, the list of blocks, and not the content of the blob itself.

serializedName

serializedName: string = "blockblob-commitblocklist-headers"

type

type: object

className

className: string = "BlockBlobCommitBlockListHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "x-ms-client-request-id"

type

type: object

name

name: "String" = "String"

contentMD5

contentMD5: object

serializedName

serializedName: string = "content-md5"

type

type: object

name

name: "ByteArray" = "ByteArray"

date

date: object

serializedName

serializedName: string = "date"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

encryptionKeySha256

encryptionKeySha256: object

serializedName

serializedName: string = "x-ms-encryption-key-sha256"

type

type: object

name

name: "String" = "String"

errorCode

errorCode: object

serializedName

serializedName: string = "x-ms-error-code"

type

type: object

name

name: "String" = "String"

isServerEncrypted

isServerEncrypted: object

serializedName

serializedName: string = "x-ms-request-server-encrypted"

type

type: object

name

name: "Boolean" = "Boolean"

lastModified

lastModified: object

serializedName

serializedName: string = "last-modified"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

requestId

requestId: object

serializedName

serializedName: string = "x-ms-request-id"

type

type: object

name

name: "String" = "String"

version

version: object

serializedName

serializedName: string = "x-ms-version"

type

type: object

name

name: "String" = "String"

xMsContentCrc64

xMsContentCrc64: object

serializedName

serializedName: string = "x-ms-content-crc64"

type

type: object

name

name: "ByteArray" = "ByteArray"

Const BlockBlobGetBlockListHeaders

BlockBlobGetBlockListHeaders: object

Defines headers for GetBlockList operation.

Optional blobContentLength

blobContentLength: undefined | number

The size of the blob in bytes.

Optional clientRequestId

clientRequestId: undefined | string

If a client request id header is sent in the request, this header will be present in the response with the same value.

Optional contentType

contentType: undefined | string

The media type of the body of the response. For Get Block List this is 'application/xml'

Optional date

date: Date

UTC date/time value generated by the service that indicates the time at which the response was initiated

Optional eTag

eTag: undefined | string

The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes.

Optional errorCode

errorCode: undefined | string

Optional lastModified

lastModified: Date

Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob.

Optional requestId

requestId: undefined | string

This header uniquely identifies the request that was made and can be used for troubleshooting the request.

Optional version

version: undefined | string

Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above.

serializedName

serializedName: string = "blockblob-getblocklist-headers"

type

type: object

className

className: string = "BlockBlobGetBlockListHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

blobContentLength

blobContentLength: object

serializedName

serializedName: string = "x-ms-blob-content-length"

type

type: object

name

name: "Number" = "Number"

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "x-ms-client-request-id"

type

type: object

name

name: "String" = "String"

contentType

contentType: object

serializedName

serializedName: string = "content-type"

type

type: object

name

name: "String" = "String"

date

date: object

serializedName

serializedName: string = "date"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

errorCode

errorCode: object

serializedName

serializedName: string = "x-ms-error-code"

type

type: object

name

name: "String" = "String"

lastModified

lastModified: object

serializedName

serializedName: string = "last-modified"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

requestId

requestId: object

serializedName

serializedName: string = "x-ms-request-id"

type

type: object

name

name: "String" = "String"

version

version: object

serializedName

serializedName: string = "x-ms-version"

type

type: object

name

name: "String" = "String"

Const BlockBlobStageBlockFromURLHeaders

BlockBlobStageBlockFromURLHeaders: object

Defines headers for StageBlockFromURL operation.

Optional clientRequestId

clientRequestId: undefined | string

If a client request id header is sent in the request, this header will be present in the response with the same value.

Optional contentMD5

contentMD5: Uint8Array

This header is returned so that the client can check for message content integrity. The value of this header is computed by the Blob service; it is not necessarily the same value specified in the request headers.

Optional date

date: Date

UTC date/time value generated by the service that indicates the time at which the response was initiated

Optional encryptionKeySha256

encryptionKeySha256: undefined | string

The SHA-256 hash of the encryption key used to encrypt the block. This header is only returned when the block was encrypted with a customer-provided key.

Optional errorCode

errorCode: undefined | string

Optional isServerEncrypted

isServerEncrypted: undefined | false | true

The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise.

Optional requestId

requestId: undefined | string

This header uniquely identifies the request that was made and can be used for troubleshooting the request.

Optional version

version: undefined | string

Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above.

Optional xMsContentCrc64

xMsContentCrc64: Uint8Array

This header is returned so that the client can check for message content integrity. The value of this header is computed by the Blob service; it is not necessarily the same value specified in the request headers.

serializedName

serializedName: string = "blockblob-stageblockfromurl-headers"

type

type: object

className

className: string = "BlockBlobStageBlockFromURLHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "x-ms-client-request-id"

type

type: object

name

name: "String" = "String"

contentMD5

contentMD5: object

serializedName

serializedName: string = "content-md5"

type

type: object

name

name: "ByteArray" = "ByteArray"

date

date: object

serializedName

serializedName: string = "date"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

encryptionKeySha256

encryptionKeySha256: object

serializedName

serializedName: string = "x-ms-encryption-key-sha256"

type

type: object

name

name: "String" = "String"

errorCode

errorCode: object

serializedName

serializedName: string = "x-ms-error-code"

type

type: object

name

name: "String" = "String"

isServerEncrypted

isServerEncrypted: object

serializedName

serializedName: string = "x-ms-request-server-encrypted"

type

type: object

name

name: "Boolean" = "Boolean"

requestId

requestId: object

serializedName

serializedName: string = "x-ms-request-id"

type

type: object

name

name: "String" = "String"

version

version: object

serializedName

serializedName: string = "x-ms-version"

type

type: object

name

name: "String" = "String"

xMsContentCrc64

xMsContentCrc64: object

serializedName

serializedName: string = "x-ms-content-crc64"

type

type: object

name

name: "ByteArray" = "ByteArray"

Const BlockBlobStageBlockHeaders

BlockBlobStageBlockHeaders: object

Defines headers for StageBlock operation.

Optional clientRequestId

clientRequestId: undefined | string

If a client request id header is sent in the request, this header will be present in the response with the same value.

Optional contentMD5

contentMD5: Uint8Array

This header is returned so that the client can check for message content integrity. The value of this header is computed by the Blob service; it is not necessarily the same value specified in the request headers.

Optional date

date: Date

UTC date/time value generated by the service that indicates the time at which the response was initiated

Optional encryptionKeySha256

encryptionKeySha256: undefined | string

The SHA-256 hash of the encryption key used to encrypt the block. This header is only returned when the block was encrypted with a customer-provided key.

Optional errorCode

errorCode: undefined | string

Optional isServerEncrypted

isServerEncrypted: undefined | false | true

The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise.

Optional requestId

requestId: undefined | string

This header uniquely identifies the request that was made and can be used for troubleshooting the request.

Optional version

version: undefined | string

Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above.

Optional xMsContentCrc64

xMsContentCrc64: Uint8Array

This header is returned so that the client can check for message content integrity. The value of this header is computed by the Blob service; it is not necessarily the same value specified in the request headers.

serializedName

serializedName: string = "blockblob-stageblock-headers"

type

type: object

className

className: string = "BlockBlobStageBlockHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "x-ms-client-request-id"

type

type: object

name

name: "String" = "String"

contentMD5

contentMD5: object

serializedName

serializedName: string = "content-md5"

type

type: object

name

name: "ByteArray" = "ByteArray"

date

date: object

serializedName

serializedName: string = "date"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

encryptionKeySha256

encryptionKeySha256: object

serializedName

serializedName: string = "x-ms-encryption-key-sha256"

type

type: object

name

name: "String" = "String"

errorCode

errorCode: object

serializedName

serializedName: string = "x-ms-error-code"

type

type: object

name

name: "String" = "String"

isServerEncrypted

isServerEncrypted: object

serializedName

serializedName: string = "x-ms-request-server-encrypted"

type

type: object

name

name: "Boolean" = "Boolean"

requestId

requestId: object

serializedName

serializedName: string = "x-ms-request-id"

type

type: object

name

name: "String" = "String"

version

version: object

serializedName

serializedName: string = "x-ms-version"

type

type: object

name

name: "String" = "String"

xMsContentCrc64

xMsContentCrc64: object

serializedName

serializedName: string = "x-ms-content-crc64"

type

type: object

name

name: "ByteArray" = "ByteArray"

Const BlockBlobUploadHeaders

BlockBlobUploadHeaders: object

Defines headers for Upload operation.

Optional clientRequestId

clientRequestId: undefined | string

If a client request id header is sent in the request, this header will be present in the response with the same value.

Optional contentMD5

contentMD5: Uint8Array

If the blob has an MD5 hash and this operation is to read the full blob, this response header is returned so that the client can check for message content integrity.

Optional date

date: Date

UTC date/time value generated by the service that indicates the time at which the response was initiated

Optional eTag

eTag: undefined | string

The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes.

Optional encryptionKeySha256

encryptionKeySha256: undefined | string

The SHA-256 hash of the encryption key used to encrypt the blob. This header is only returned when the blob was encrypted with a customer-provided key.

Optional errorCode

errorCode: undefined | string

Optional isServerEncrypted

isServerEncrypted: undefined | false | true

The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise.

Optional lastModified

lastModified: Date

Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob.

Optional requestId

requestId: undefined | string

This header uniquely identifies the request that was made and can be used for troubleshooting the request.

Optional version

version: undefined | string

Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above.

serializedName

serializedName: string = "blockblob-upload-headers"

type

type: object

className

className: string = "BlockBlobUploadHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "x-ms-client-request-id"

type

type: object

name

name: "String" = "String"

contentMD5

contentMD5: object

serializedName

serializedName: string = "content-md5"

type

type: object

name

name: "ByteArray" = "ByteArray"

date

date: object

serializedName

serializedName: string = "date"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

encryptionKeySha256

encryptionKeySha256: object

serializedName

serializedName: string = "x-ms-encryption-key-sha256"

type

type: object

name

name: "String" = "String"

errorCode

errorCode: object

serializedName

serializedName: string = "x-ms-error-code"

type

type: object

name

name: "String" = "String"

isServerEncrypted

isServerEncrypted: object

serializedName

serializedName: string = "x-ms-request-server-encrypted"

type

type: object

name

name: "Boolean" = "Boolean"

lastModified

lastModified: object

serializedName

serializedName: string = "last-modified"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

requestId

requestId: object

serializedName

serializedName: string = "x-ms-request-id"

type

type: object

name

name: "String" = "String"

version

version: object

serializedName

serializedName: string = "x-ms-version"

type

type: object

name

name: "String" = "String"

Const BlockList

BlockList: object

An interface representing BlockList.

Optional committedBlocks

committedBlocks: Block[]

Optional uncommittedBlocks

uncommittedBlocks: Block[]

serializedName

serializedName: string = "BlockList"

type

type: object

className

className: string = "BlockList"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

committedBlocks

committedBlocks: object

serializedName

serializedName: string = "CommittedBlocks"

xmlElementName

xmlElementName: string = "Block"

xmlIsWrapped

xmlIsWrapped: true = true

xmlName

xmlName: string = "CommittedBlocks"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "Block"

name

name: "Composite" = "Composite"

uncommittedBlocks

uncommittedBlocks: object

serializedName

serializedName: string = "UncommittedBlocks"

xmlElementName

xmlElementName: string = "Block"

xmlIsWrapped

xmlIsWrapped: true = true

xmlName

xmlName: string = "UncommittedBlocks"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "Block"

name

name: "Composite" = "Composite"

Const BlockLookupList

BlockLookupList: object

An interface representing BlockLookupList.

Optional committed

committed: string[]

Optional latest

latest: string[]

Optional uncommitted

uncommitted: string[]

serializedName

serializedName: string = "BlockLookupList"

xmlName

xmlName: string = "BlockList"

type

type: object

className

className: string = "BlockLookupList"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

committed

committed: object

serializedName

serializedName: string = "Committed"

xmlElementName

xmlElementName: string = "Committed"

xmlName

xmlName: string = "Committed"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

latest

latest: object

serializedName

serializedName: string = "Latest"

xmlElementName

xmlElementName: string = "Latest"

xmlName

xmlName: string = "Latest"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

uncommitted

uncommitted: object

serializedName

serializedName: string = "Uncommitted"

xmlElementName

xmlElementName: string = "Uncommitted"

xmlName

xmlName: string = "Uncommitted"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

Const ClearRange

ClearRange: object

An interface representing ClearRange.

end

end: number

start

start: number

serializedName

serializedName: string = "ClearRange"

type

type: object

className

className: string = "ClearRange"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

end

end: object

required

required: true = true

serializedName

serializedName: string = "End"

xmlName

xmlName: string = "End"

type

type: object

name

name: "Number" = "Number"

start

start: object

required

required: true = true

serializedName

serializedName: string = "Start"

xmlName

xmlName: string = "Start"

type

type: object

name

name: "Number" = "Number"

Const ContainerAcquireLeaseHeaders

ContainerAcquireLeaseHeaders: object

Defines headers for AcquireLease operation.

Optional clientRequestId

clientRequestId: undefined | string

If a client request id header is sent in the request, this header will be present in the response with the same value.

Optional date

date: Date

UTC date/time value generated by the service that indicates the time at which the response was initiated

Optional eTag

eTag: undefined | string

The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes.

Optional errorCode

errorCode: undefined | string

Optional lastModified

lastModified: Date

Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob.

Optional leaseId

leaseId: undefined | string

Uniquely identifies a container's lease

Optional requestId

requestId: undefined | string

This header uniquely identifies the request that was made and can be used for troubleshooting the request.

Optional version

version: undefined | string

Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above.

serializedName

serializedName: string = "container-acquirelease-headers"

type

type: object

className

className: string = "ContainerAcquireLeaseHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "x-ms-client-request-id"

type

type: object

name

name: "String" = "String"

date

date: object

serializedName

serializedName: string = "date"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

errorCode

errorCode: object

serializedName

serializedName: string = "x-ms-error-code"

type

type: object

name

name: "String" = "String"

lastModified

lastModified: object

serializedName

serializedName: string = "last-modified"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

leaseId

leaseId: object

serializedName

serializedName: string = "x-ms-lease-id"

type

type: object

name

name: "String" = "String"

requestId

requestId: object

serializedName

serializedName: string = "x-ms-request-id"

type

type: object

name

name: "String" = "String"

version

version: object

serializedName

serializedName: string = "x-ms-version"

type

type: object

name

name: "String" = "String"

Const ContainerBreakLeaseHeaders

ContainerBreakLeaseHeaders: object

Defines headers for BreakLease operation.

Optional clientRequestId

clientRequestId: undefined | string

If a client request id header is sent in the request, this header will be present in the response with the same value.

Optional date

date: Date

UTC date/time value generated by the service that indicates the time at which the response was initiated

Optional eTag

eTag: undefined | string

The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes.

Optional errorCode

errorCode: undefined | string

Optional lastModified

lastModified: Date

Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob.

Optional leaseTime

leaseTime: undefined | number

Approximate time remaining in the lease period, in seconds.

Optional requestId

requestId: undefined | string

This header uniquely identifies the request that was made and can be used for troubleshooting the request.

Optional version

version: undefined | string

Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above.

serializedName

serializedName: string = "container-breaklease-headers"

type

type: object

className

className: string = "ContainerBreakLeaseHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "x-ms-client-request-id"

type

type: object

name

name: "String" = "String"

date

date: object

serializedName

serializedName: string = "date"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

errorCode

errorCode: object

serializedName

serializedName: string = "x-ms-error-code"

type

type: object

name

name: "String" = "String"

lastModified

lastModified: object

serializedName

serializedName: string = "last-modified"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

leaseTime

leaseTime: object

serializedName

serializedName: string = "x-ms-lease-time"

type

type: object

name

name: "Number" = "Number"

requestId

requestId: object

serializedName

serializedName: string = "x-ms-request-id"

type

type: object

name

name: "String" = "String"

version

version: object

serializedName

serializedName: string = "x-ms-version"

type

type: object

name

name: "String" = "String"

Const ContainerChangeLeaseHeaders

ContainerChangeLeaseHeaders: object

Defines headers for ChangeLease operation.

Optional clientRequestId

clientRequestId: undefined | string

If a client request id header is sent in the request, this header will be present in the response with the same value.

Optional date

date: Date

UTC date/time value generated by the service that indicates the time at which the response was initiated

Optional eTag

eTag: undefined | string

The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes.

Optional errorCode

errorCode: undefined | string

Optional lastModified

lastModified: Date

Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob.

Optional leaseId

leaseId: undefined | string

Uniquely identifies a container's lease

Optional requestId

requestId: undefined | string

This header uniquely identifies the request that was made and can be used for troubleshooting the request.

Optional version

version: undefined | string

Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above.

serializedName

serializedName: string = "container-changelease-headers"

type

type: object

className

className: string = "ContainerChangeLeaseHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "x-ms-client-request-id"

type

type: object

name

name: "String" = "String"

date

date: object

serializedName

serializedName: string = "date"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

errorCode

errorCode: object

serializedName

serializedName: string = "x-ms-error-code"

type

type: object

name

name: "String" = "String"

lastModified

lastModified: object

serializedName

serializedName: string = "last-modified"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

leaseId

leaseId: object

serializedName

serializedName: string = "x-ms-lease-id"

type

type: object

name

name: "String" = "String"

requestId

requestId: object

serializedName

serializedName: string = "x-ms-request-id"

type

type: object

name

name: "String" = "String"

version

version: object

serializedName

serializedName: string = "x-ms-version"

type

type: object

name

name: "String" = "String"

Const ContainerCreateHeaders

ContainerCreateHeaders: object

Defines headers for Create operation.

Optional clientRequestId

clientRequestId: undefined | string

If a client request id header is sent in the request, this header will be present in the response with the same value.

Optional date

date: Date

UTC date/time value generated by the service that indicates the time at which the response was initiated

Optional eTag

eTag: undefined | string

The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes.

Optional errorCode

errorCode: undefined | string

Optional lastModified

lastModified: Date

Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob.

Optional requestId

requestId: undefined | string

This header uniquely identifies the request that was made and can be used for troubleshooting the request.

Optional version

version: undefined | string

Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above.

serializedName

serializedName: string = "container-create-headers"

type

type: object

className

className: string = "ContainerCreateHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "x-ms-client-request-id"

type

type: object

name

name: "String" = "String"

date

date: object

serializedName

serializedName: string = "date"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

errorCode

errorCode: object

serializedName

serializedName: string = "x-ms-error-code"

type

type: object

name

name: "String" = "String"

lastModified

lastModified: object

serializedName

serializedName: string = "last-modified"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

requestId

requestId: object

serializedName

serializedName: string = "x-ms-request-id"

type

type: object

name

name: "String" = "String"

version

version: object

serializedName

serializedName: string = "x-ms-version"

type

type: object

name

name: "String" = "String"

Const ContainerDeleteHeaders

ContainerDeleteHeaders: object

Defines headers for Delete operation.

Optional clientRequestId

clientRequestId: undefined | string

If a client request id header is sent in the request, this header will be present in the response with the same value.

Optional date

date: Date

UTC date/time value generated by the service that indicates the time at which the response was initiated

Optional errorCode

errorCode: undefined | string

Optional requestId

requestId: undefined | string

This header uniquely identifies the request that was made and can be used for troubleshooting the request.

Optional version

version: undefined | string

Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above.

serializedName

serializedName: string = "container-delete-headers"

type

type: object

className

className: string = "ContainerDeleteHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "x-ms-client-request-id"

type

type: object

name

name: "String" = "String"

date

date: object

serializedName

serializedName: string = "date"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

errorCode

errorCode: object

serializedName

serializedName: string = "x-ms-error-code"

type

type: object

name

name: "String" = "String"

requestId

requestId: object

serializedName

serializedName: string = "x-ms-request-id"

type

type: object

name

name: "String" = "String"

version

version: object

serializedName

serializedName: string = "x-ms-version"

type

type: object

name

name: "String" = "String"

Const ContainerGetAccessPolicyHeaders

ContainerGetAccessPolicyHeaders: object

Defines headers for GetAccessPolicy operation.

Optional blobPublicAccess

blobPublicAccess: PublicAccessType

Indicated whether data in the container may be accessed publicly and the level of access. Possible values include: 'container', 'blob'

Optional clientRequestId

clientRequestId: undefined | string

If a client request id header is sent in the request, this header will be present in the response with the same value.

Optional date

date: Date

UTC date/time value generated by the service that indicates the time at which the response was initiated

Optional eTag

eTag: undefined | string

The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes.

Optional errorCode

errorCode: undefined | string

Optional lastModified

lastModified: Date

Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob.

Optional requestId

requestId: undefined | string

This header uniquely identifies the request that was made and can be used for troubleshooting the request.

Optional version

version: undefined | string

Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above.

serializedName

serializedName: string = "container-getaccesspolicy-headers"

type

type: object

className

className: string = "ContainerGetAccessPolicyHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

blobPublicAccess

blobPublicAccess: object

serializedName

serializedName: string = "x-ms-blob-public-access"

type

type: object

name

name: "String" = "String"

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "x-ms-client-request-id"

type

type: object

name

name: "String" = "String"

date

date: object

serializedName

serializedName: string = "date"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

errorCode

errorCode: object

serializedName

serializedName: string = "x-ms-error-code"

type

type: object

name

name: "String" = "String"

lastModified

lastModified: object

serializedName

serializedName: string = "last-modified"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

requestId

requestId: object

serializedName

serializedName: string = "x-ms-request-id"

type

type: object

name

name: "String" = "String"

version

version: object

serializedName

serializedName: string = "x-ms-version"

type

type: object

name

name: "String" = "String"

Const ContainerGetAccountInfoHeaders

ContainerGetAccountInfoHeaders: object

Defines headers for GetAccountInfo operation.

Optional accountKind

accountKind: AccountKind

Identifies the account kind. Possible values include: 'Storage', 'BlobStorage', 'StorageV2'

Optional clientRequestId

clientRequestId: undefined | string

If a client request id header is sent in the request, this header will be present in the response with the same value.

Optional date

date: Date

UTC date/time value generated by the service that indicates the time at which the response was initiated

Optional errorCode

errorCode: undefined | string

Optional requestId

requestId: undefined | string

This header uniquely identifies the request that was made and can be used for troubleshooting the request.

Optional skuName

skuName: SkuName

Identifies the sku name of the account. Possible values include: 'Standard_LRS', 'Standard_GRS', 'Standard_RAGRS', 'Standard_ZRS', 'Premium_LRS'

Optional version

version: undefined | string

Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above.

serializedName

serializedName: string = "container-getaccountinfo-headers"

type

type: object

className

className: string = "ContainerGetAccountInfoHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

accountKind

accountKind: object

serializedName

serializedName: string = "x-ms-account-kind"

type

type: object

allowedValues

allowedValues: string[] = ["Storage","BlobStorage","StorageV2"]

name

name: "Enum" = "Enum"

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "x-ms-client-request-id"

type

type: object

name

name: "String" = "String"

date

date: object

serializedName

serializedName: string = "date"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

errorCode

errorCode: object

serializedName

serializedName: string = "x-ms-error-code"

type

type: object

name

name: "String" = "String"

requestId

requestId: object

serializedName

serializedName: string = "x-ms-request-id"

type

type: object

name

name: "String" = "String"

skuName

skuName: object

serializedName

serializedName: string = "x-ms-sku-name"

type

type: object

allowedValues

allowedValues: string[] = ["Standard_LRS","Standard_GRS","Standard_RAGRS","Standard_ZRS","Premium_LRS"]

name

name: "Enum" = "Enum"

version

version: object

serializedName

serializedName: string = "x-ms-version"

type

type: object

name

name: "String" = "String"

Const ContainerGetPropertiesHeaders

ContainerGetPropertiesHeaders: object

Defines headers for GetProperties operation.

Optional blobPublicAccess

blobPublicAccess: PublicAccessType

Indicated whether data in the container may be accessed publicly and the level of access. Possible values include: 'container', 'blob'

Optional clientRequestId

clientRequestId: undefined | string

If a client request id header is sent in the request, this header will be present in the response with the same value.

Optional date

date: Date

UTC date/time value generated by the service that indicates the time at which the response was initiated

Optional eTag

eTag: undefined | string

The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes.

Optional errorCode

errorCode: undefined | string

Optional hasImmutabilityPolicy

hasImmutabilityPolicy: undefined | false | true

Indicates whether the container has an immutability policy set on it.

Optional hasLegalHold

hasLegalHold: undefined | false | true

Indicates whether the container has a legal hold.

Optional lastModified

lastModified: Date

Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob.

Optional leaseDuration

leaseDuration: LeaseDurationType

When a blob is leased, specifies whether the lease is of infinite or fixed duration. Possible values include: 'infinite', 'fixed'

Optional leaseState

leaseState: LeaseStateType

Lease state of the blob. Possible values include: 'available', 'leased', 'expired', 'breaking', 'broken'

Optional leaseStatus

leaseStatus: LeaseStatusType

The current lease status of the blob. Possible values include: 'locked', 'unlocked'

Optional metadata

metadata: undefined | object

Optional requestId

requestId: undefined | string

This header uniquely identifies the request that was made and can be used for troubleshooting the request.

Optional version

version: undefined | string

Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above.

serializedName

serializedName: string = "container-getproperties-headers"

type

type: object

className

className: string = "ContainerGetPropertiesHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

blobPublicAccess

blobPublicAccess: object

serializedName

serializedName: string = "x-ms-blob-public-access"

type

type: object

name

name: "String" = "String"

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "x-ms-client-request-id"

type

type: object

name

name: "String" = "String"

date

date: object

serializedName

serializedName: string = "date"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

errorCode

errorCode: object

serializedName

serializedName: string = "x-ms-error-code"

type

type: object

name

name: "String" = "String"

hasImmutabilityPolicy

hasImmutabilityPolicy: object

serializedName

serializedName: string = "x-ms-has-immutability-policy"

type

type: object

name

name: "Boolean" = "Boolean"

hasLegalHold

hasLegalHold: object

serializedName

serializedName: string = "x-ms-has-legal-hold"

type

type: object

name

name: "Boolean" = "Boolean"

lastModified

lastModified: object

serializedName

serializedName: string = "last-modified"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

leaseDuration

leaseDuration: object

serializedName

serializedName: string = "x-ms-lease-duration"

type

type: object

allowedValues

allowedValues: string[] = ["infinite","fixed"]

name

name: "Enum" = "Enum"

leaseState

leaseState: object

serializedName

serializedName: string = "x-ms-lease-state"

type

type: object

allowedValues

allowedValues: string[] = ["available","leased","expired","breaking","broken"]

name

name: "Enum" = "Enum"

leaseStatus

leaseStatus: object

serializedName

serializedName: string = "x-ms-lease-status"

type

type: object

allowedValues

allowedValues: string[] = ["locked","unlocked"]

name

name: "Enum" = "Enum"

metadata

metadata: object

headerCollectionPrefix

headerCollectionPrefix: string = "x-ms-meta-"

serializedName

serializedName: string = "x-ms-meta"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "String" = "String"

requestId

requestId: object

serializedName

serializedName: string = "x-ms-request-id"

type

type: object

name

name: "String" = "String"

version

version: object

serializedName

serializedName: string = "x-ms-version"

type

type: object

name

name: "String" = "String"

Const ContainerItem

ContainerItem: object

An Azure Storage container

Optional metadata

metadata: undefined | object

name

name: string

properties

serializedName

serializedName: string = "ContainerItem"

xmlName

xmlName: string = "Container"

type

type: object

className

className: string = "ContainerItem"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

metadata

metadata: object

serializedName

serializedName: string = "Metadata"

xmlName

xmlName: string = "Metadata"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "String" = "String"

name

name: object

required

required: true = true

serializedName

serializedName: string = "Name"

xmlName

xmlName: string = "Name"

type

type: object

name

name: "String" = "String"

properties

properties: object

required

required: true = true

serializedName

serializedName: string = "Properties"

xmlName

xmlName: string = "Properties"

type

type: object

className

className: string = "ContainerProperties"

name

name: "Composite" = "Composite"

Const ContainerListBlobFlatSegmentHeaders

ContainerListBlobFlatSegmentHeaders: object

Defines headers for ListBlobFlatSegment operation.

Optional clientRequestId

clientRequestId: undefined | string

If a client request id header is sent in the request, this header will be present in the response with the same value.

Optional contentType

contentType: undefined | string

The media type of the body of the response. For List Blobs this is 'application/xml'

Optional date

date: Date

UTC date/time value generated by the service that indicates the time at which the response was initiated

Optional errorCode

errorCode: undefined | string

Optional requestId

requestId: undefined | string

This header uniquely identifies the request that was made and can be used for troubleshooting the request.

Optional version

version: undefined | string

Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above.

serializedName

serializedName: string = "container-listblobflatsegment-headers"

type

type: object

className

className: string = "ContainerListBlobFlatSegmentHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "x-ms-client-request-id"

type

type: object

name

name: "String" = "String"

contentType

contentType: object

serializedName

serializedName: string = "content-type"

type

type: object

name

name: "String" = "String"

date

date: object

serializedName

serializedName: string = "date"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

errorCode

errorCode: object

serializedName

serializedName: string = "x-ms-error-code"

type

type: object

name

name: "String" = "String"

requestId

requestId: object

serializedName

serializedName: string = "x-ms-request-id"

type

type: object

name

name: "String" = "String"

version

version: object

serializedName

serializedName: string = "x-ms-version"

type

type: object

name

name: "String" = "String"

Const ContainerListBlobHierarchySegmentHeaders

ContainerListBlobHierarchySegmentHeaders: object

Defines headers for ListBlobHierarchySegment operation.

Optional clientRequestId

clientRequestId: undefined | string

If a client request id header is sent in the request, this header will be present in the response with the same value.

Optional contentType

contentType: undefined | string

The media type of the body of the response. For List Blobs this is 'application/xml'

Optional date

date: Date

UTC date/time value generated by the service that indicates the time at which the response was initiated

Optional errorCode

errorCode: undefined | string

Optional requestId

requestId: undefined | string

This header uniquely identifies the request that was made and can be used for troubleshooting the request.

Optional version

version: undefined | string

Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above.

serializedName

serializedName: string = "container-listblobhierarchysegment-headers"

type

type: object

className

className: string = "ContainerListBlobHierarchySegmentHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "x-ms-client-request-id"

type

type: object

name

name: "String" = "String"

contentType

contentType: object

serializedName

serializedName: string = "content-type"

type

type: object

name

name: "String" = "String"

date

date: object

serializedName

serializedName: string = "date"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

errorCode

errorCode: object

serializedName

serializedName: string = "x-ms-error-code"

type

type: object

name

name: "String" = "String"

requestId

requestId: object

serializedName

serializedName: string = "x-ms-request-id"

type

type: object

name

name: "String" = "String"

version

version: object

serializedName

serializedName: string = "x-ms-version"

type

type: object

name

name: "String" = "String"

Const ContainerProperties

ContainerProperties: object

Properties of a container

etag

etag: string

Optional hasImmutabilityPolicy

hasImmutabilityPolicy: undefined | false | true

Optional hasLegalHold

hasLegalHold: undefined | false | true

lastModified

lastModified: Date

Optional leaseDuration

leaseDuration: LeaseDurationType

Possible values include: 'infinite', 'fixed'

Optional leaseState

leaseState: LeaseStateType

Possible values include: 'available', 'leased', 'expired', 'breaking', 'broken'

Optional leaseStatus

leaseStatus: LeaseStatusType

Possible values include: 'locked', 'unlocked'

Optional publicAccess

publicAccess: PublicAccessType

Possible values include: 'container', 'blob'

serializedName

serializedName: string = "ContainerProperties"

type

type: object

className

className: string = "ContainerProperties"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

etag

etag: object

required

required: true = true

serializedName

serializedName: string = "Etag"

xmlName

xmlName: string = "Etag"

type

type: object

name

name: "String" = "String"

hasImmutabilityPolicy

hasImmutabilityPolicy: object

serializedName

serializedName: string = "HasImmutabilityPolicy"

xmlName

xmlName: string = "HasImmutabilityPolicy"

type

type: object

name

name: "Boolean" = "Boolean"

hasLegalHold

hasLegalHold: object

serializedName

serializedName: string = "HasLegalHold"

xmlName

xmlName: string = "HasLegalHold"

type

type: object

name

name: "Boolean" = "Boolean"

lastModified

lastModified: object

required

required: true = true

serializedName

serializedName: string = "Last-Modified"

xmlName

xmlName: string = "Last-Modified"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

leaseDuration

leaseDuration: object

serializedName

serializedName: string = "LeaseDuration"

xmlName

xmlName: string = "LeaseDuration"

type

type: object

allowedValues

allowedValues: string[] = ["infinite","fixed"]

name

name: "Enum" = "Enum"

leaseState

leaseState: object

serializedName

serializedName: string = "LeaseState"

xmlName

xmlName: string = "LeaseState"

type

type: object

allowedValues

allowedValues: string[] = ["available","leased","expired","breaking","broken"]

name

name: "Enum" = "Enum"

leaseStatus

leaseStatus: object

serializedName

serializedName: string = "LeaseStatus"

xmlName

xmlName: string = "LeaseStatus"

type

type: object

allowedValues

allowedValues: string[] = ["locked","unlocked"]

name

name: "Enum" = "Enum"

publicAccess

publicAccess: object

serializedName

serializedName: string = "PublicAccess"

xmlName

xmlName: string = "PublicAccess"

type

type: object

name

name: "String" = "String"

Const ContainerReleaseLeaseHeaders

ContainerReleaseLeaseHeaders: object

Defines headers for ReleaseLease operation.

Optional clientRequestId

clientRequestId: undefined | string

If a client request id header is sent in the request, this header will be present in the response with the same value.

Optional date

date: Date

UTC date/time value generated by the service that indicates the time at which the response was initiated

Optional eTag

eTag: undefined | string

The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes.

Optional errorCode

errorCode: undefined | string

Optional lastModified

lastModified: Date

Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob.

Optional requestId

requestId: undefined | string

This header uniquely identifies the request that was made and can be used for troubleshooting the request.

Optional version

version: undefined | string

Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above.

serializedName

serializedName: string = "container-releaselease-headers"

type

type: object

className

className: string = "ContainerReleaseLeaseHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "x-ms-client-request-id"

type

type: object

name

name: "String" = "String"

date

date: object

serializedName

serializedName: string = "date"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

errorCode

errorCode: object

serializedName

serializedName: string = "x-ms-error-code"

type

type: object

name

name: "String" = "String"

lastModified

lastModified: object

serializedName

serializedName: string = "last-modified"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

requestId

requestId: object

serializedName

serializedName: string = "x-ms-request-id"

type

type: object

name

name: "String" = "String"

version

version: object

serializedName

serializedName: string = "x-ms-version"

type

type: object

name

name: "String" = "String"

Const ContainerRenewLeaseHeaders

ContainerRenewLeaseHeaders: object

Defines headers for RenewLease operation.

Optional clientRequestId

clientRequestId: undefined | string

If a client request id header is sent in the request, this header will be present in the response with the same value.

Optional date

date: Date

UTC date/time value generated by the service that indicates the time at which the response was initiated

Optional eTag

eTag: undefined | string

The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes.

Optional errorCode

errorCode: undefined | string

Optional lastModified

lastModified: Date

Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob.

Optional leaseId

leaseId: undefined | string

Uniquely identifies a container's lease

Optional requestId

requestId: undefined | string

This header uniquely identifies the request that was made and can be used for troubleshooting the request.

Optional version

version: undefined | string

Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above.

serializedName

serializedName: string = "container-renewlease-headers"

type

type: object

className

className: string = "ContainerRenewLeaseHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "x-ms-client-request-id"

type

type: object

name

name: "String" = "String"

date

date: object

serializedName

serializedName: string = "date"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

errorCode

errorCode: object

serializedName

serializedName: string = "x-ms-error-code"

type

type: object

name

name: "String" = "String"

lastModified

lastModified: object

serializedName

serializedName: string = "last-modified"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

leaseId

leaseId: object

serializedName

serializedName: string = "x-ms-lease-id"

type

type: object

name

name: "String" = "String"

requestId

requestId: object

serializedName

serializedName: string = "x-ms-request-id"

type

type: object

name

name: "String" = "String"

version

version: object

serializedName

serializedName: string = "x-ms-version"

type

type: object

name

name: "String" = "String"

Const ContainerSetAccessPolicyHeaders

ContainerSetAccessPolicyHeaders: object

Defines headers for SetAccessPolicy operation.

Optional clientRequestId

clientRequestId: undefined | string

If a client request id header is sent in the request, this header will be present in the response with the same value.

Optional date

date: Date

UTC date/time value generated by the service that indicates the time at which the response was initiated

Optional eTag

eTag: undefined | string

The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes.

Optional errorCode

errorCode: undefined | string

Optional lastModified

lastModified: Date

Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob.

Optional requestId

requestId: undefined | string

This header uniquely identifies the request that was made and can be used for troubleshooting the request.

Optional version

version: undefined | string

Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above.

serializedName

serializedName: string = "container-setaccesspolicy-headers"

type

type: object

className

className: string = "ContainerSetAccessPolicyHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "x-ms-client-request-id"

type

type: object

name

name: "String" = "String"

date

date: object

serializedName

serializedName: string = "date"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

errorCode

errorCode: object

serializedName

serializedName: string = "x-ms-error-code"

type

type: object

name

name: "String" = "String"

lastModified

lastModified: object

serializedName

serializedName: string = "last-modified"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

requestId

requestId: object

serializedName

serializedName: string = "x-ms-request-id"

type

type: object

name

name: "String" = "String"

version

version: object

serializedName

serializedName: string = "x-ms-version"

type

type: object

name

name: "String" = "String"

Const ContainerSetMetadataHeaders

ContainerSetMetadataHeaders: object

Defines headers for SetMetadata operation.

Optional clientRequestId

clientRequestId: undefined | string

If a client request id header is sent in the request, this header will be present in the response with the same value.

Optional date

date: Date

UTC date/time value generated by the service that indicates the time at which the response was initiated

Optional eTag

eTag: undefined | string

The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes.

Optional errorCode

errorCode: undefined | string

Optional lastModified

lastModified: Date

Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob.

Optional requestId

requestId: undefined | string

This header uniquely identifies the request that was made and can be used for troubleshooting the request.

Optional version

version: undefined | string

Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above.

serializedName

serializedName: string = "container-setmetadata-headers"

type

type: object

className

className: string = "ContainerSetMetadataHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "x-ms-client-request-id"

type

type: object

name

name: "String" = "String"

date

date: object

serializedName

serializedName: string = "date"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

errorCode

errorCode: object

serializedName

serializedName: string = "x-ms-error-code"

type

type: object

name

name: "String" = "String"

lastModified

lastModified: object

serializedName

serializedName: string = "last-modified"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

requestId

requestId: object

serializedName

serializedName: string = "x-ms-request-id"

type

type: object

name

name: "String" = "String"

version

version: object

serializedName

serializedName: string = "x-ms-version"

type

type: object

name

name: "String" = "String"

Const CorsRule

CorsRule: object

CORS is an HTTP feature that enables a web application running under one domain to access resources in another domain. Web browsers implement a security restriction known as same-origin policy that prevents a web page from calling APIs in a different domain; CORS provides a secure way to allow one domain (the origin domain) to call APIs in another domain

allowedHeaders

allowedHeaders: string

the request headers that the origin domain may specify on the CORS request.

allowedMethods

allowedMethods: string

The methods (HTTP request verbs) that the origin domain may use for a CORS request. (comma separated)

allowedOrigins

allowedOrigins: string

The origin domains that are permitted to make a request against the storage service via CORS. The origin domain is the domain from which the request originates. Note that the origin must be an exact case-sensitive match with the origin that the user age sends to the service. You can also use the wildcard character '*' to allow all origin domains to make requests via CORS.

exposedHeaders

exposedHeaders: string

The response headers that may be sent in the response to the CORS request and exposed by the browser to the request issuer

maxAgeInSeconds

maxAgeInSeconds: number

The maximum amount time that a browser should cache the preflight OPTIONS request.

serializedName

serializedName: string = "CorsRule"

type

type: object

className

className: string = "CorsRule"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

allowedHeaders

allowedHeaders: object

required

required: true = true

serializedName

serializedName: string = "AllowedHeaders"

xmlName

xmlName: string = "AllowedHeaders"

type

type: object

name

name: "String" = "String"

allowedMethods

allowedMethods: object

required

required: true = true

serializedName

serializedName: string = "AllowedMethods"

xmlName

xmlName: string = "AllowedMethods"

type

type: object

name

name: "String" = "String"

allowedOrigins

allowedOrigins: object

required

required: true = true

serializedName

serializedName: string = "AllowedOrigins"

xmlName

xmlName: string = "AllowedOrigins"

type

type: object

name

name: "String" = "String"

exposedHeaders

exposedHeaders: object

required

required: true = true

serializedName

serializedName: string = "ExposedHeaders"

xmlName

xmlName: string = "ExposedHeaders"

type

type: object

name

name: "String" = "String"

maxAgeInSeconds

maxAgeInSeconds: object

required

required: true = true

serializedName

serializedName: string = "MaxAgeInSeconds"

xmlName

xmlName: string = "MaxAgeInSeconds"

constraints

constraints: object

InclusiveMinimum

InclusiveMinimum: number = 0

type

type: object

name

name: "Number" = "Number"

Const CpkInfo

CpkInfo: object

Additional parameters for a set of operations.

Optional encryptionAlgorithm

encryptionAlgorithm: EncryptionAlgorithmType

The algorithm used to produce the encryption key hash. Currently, the only accepted value is "AES256". Must be provided if the x-ms-encryption-key header is provided. Possible values include: 'AES256'

Optional encryptionKey

encryptionKey: undefined | string

Optional. Specifies the encryption key to use to encrypt the data provided in the request. If not specified, encryption is performed with the root account encryption key. For more information, see Encryption at Rest for Azure Storage Services.

Optional encryptionKeySha256

encryptionKeySha256: undefined | string

The SHA-256 hash of the provided encryption key. Must be provided if the x-ms-encryption-key header is provided.

xmlName

xmlName: string = "cpk-info"

type

type: object

className

className: string = "CpkInfo"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

encryptionAlgorithm

encryptionAlgorithm: object

xmlName

xmlName: string = "encryptionAlgorithm"

type

type: object

allowedValues

allowedValues: string[] = ["AES256"]

name

name: "Enum" = "Enum"

encryptionKey

encryptionKey: object

xmlName

xmlName: string = "encryptionKey"

type

type: object

name

name: "String" = "String"

encryptionKeySha256

encryptionKeySha256: object

xmlName

xmlName: string = "encryptionKeySha256"

type

type: object

name

name: "String" = "String"

Const DataLakeStorageError

DataLakeStorageError: object

An interface representing DataLakeStorageError.

Optional error

The service error response object.

serializedName

serializedName: string = "DataLakeStorageError"

type

type: object

className

className: string = "DataLakeStorageError"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

error

error: object

serializedName

serializedName: string = "error"

xmlName

xmlName: string = "error"

type

type: object

className

className: string = "DataLakeStorageErrorError"

name

name: "Composite" = "Composite"

Const DataLakeStorageErrorError

DataLakeStorageErrorError: object

The service error response object.

Optional code

code: undefined | string

The service error code.

Optional message

message: undefined | string

The service error message.

serializedName

serializedName: string = "DataLakeStorageError_error"

type

type: object

className

className: string = "DataLakeStorageErrorError"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

code

code: object

serializedName

serializedName: string = "Code"

xmlName

xmlName: string = "Code"

type

type: object

name

name: "String" = "String"

message

message: object

serializedName

serializedName: string = "Message"

xmlName

xmlName: string = "Message"

type

type: object

name

name: "String" = "String"

Const DirectoryCreateHeaders

DirectoryCreateHeaders: object

Defines headers for Create operation.

Optional clientRequestId

clientRequestId: undefined | string

If a client request id header is sent in the request, this header will be present in the response with the same value.

Optional contentLength

contentLength: undefined | number

The size of the resource in bytes.

Optional date

date: Date

A UTC date/time value generated by the service that indicates the time at which the response was initiated.

Optional eTag

eTag: undefined | string

An HTTP entity tag associated with the file or directory.

Optional lastModified

lastModified: Date

The data and time the file or directory was last modified. Write operations on the file or directory update the last modified time.

Optional requestId

requestId: undefined | string

A server-generated UUID recorded in the analytics logs for troubleshooting and correlation.

Optional version

version: undefined | string

The version of the REST protocol used to process the request.

serializedName

serializedName: string = "directory-create-headers"

type

type: object

className

className: string = "DirectoryCreateHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "x-ms-client-request-id"

type

type: object

name

name: "String" = "String"

contentLength

contentLength: object

serializedName

serializedName: string = "content-length"

type

type: object

name

name: "Number" = "Number"

date

date: object

serializedName

serializedName: string = "date"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

lastModified

lastModified: object

serializedName

serializedName: string = "last-modified"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

requestId

requestId: object

serializedName

serializedName: string = "x-ms-request-id"

type

type: object

name

name: "String" = "String"

version

version: object

serializedName

serializedName: string = "x-ms-version"

type

type: object

name

name: "String" = "String"

Const DirectoryDeleteHeaders

DirectoryDeleteHeaders: object

Defines headers for Delete operation.

Optional clientRequestId

clientRequestId: undefined | string

If a client request id header is sent in the request, this header will be present in the response with the same value.

Optional date

date: Date

A UTC date/time value generated by the service that indicates the time at which the response was initiated.

Optional marker

marker: undefined | string

When renaming a directory, the number of paths that are renamed with each invocation is limited. If the number of paths to be renamed exceeds this limit, a continuation token is returned in this response header. When a continuation token is returned in the response, it must be specified in a subsequent invocation of the rename operation to continue renaming the directory.

Optional requestId

requestId: undefined | string

A server-generated UUID recorded in the analytics logs for troubleshooting and correlation.

Optional version

version: undefined | string

The version of the REST protocol used to process the request.

serializedName

serializedName: string = "directory-delete-headers"

type

type: object

className

className: string = "DirectoryDeleteHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "x-ms-client-request-id"

type

type: object

name

name: "String" = "String"

date

date: object

serializedName

serializedName: string = "date"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

marker

marker: object

serializedName

serializedName: string = "x-ms-continuation"

type

type: object

name

name: "String" = "String"

requestId

requestId: object

serializedName

serializedName: string = "x-ms-request-id"

type

type: object

name

name: "String" = "String"

version

version: object

serializedName

serializedName: string = "x-ms-version"

type

type: object

name

name: "String" = "String"

Const DirectoryGetAccessControlHeaders

DirectoryGetAccessControlHeaders: object

Defines headers for GetAccessControl operation.

Optional clientRequestId

clientRequestId: undefined | string

If a client request id header is sent in the request, this header will be present in the response with the same value.

Optional date

date: Date

A UTC date/time value generated by the service that indicates the time at which the response was initiated.

Optional eTag

eTag: undefined | string

An HTTP entity tag associated with the file or directory.

Optional lastModified

lastModified: Date

The data and time the file or directory was last modified. Write operations on the file or directory update the last modified time.

Optional requestId

requestId: undefined | string

A server-generated UUID recorded in the analytics logs for troubleshooting and correlation.

Optional version

version: undefined | string

The version of the REST protocol used to process the request.

Optional xMsAcl

xMsAcl: undefined | string

The POSIX access control list for the file or directory. Included in the response only if the action is "getAccessControl" and Hierarchical Namespace is enabled for the account.

Optional xMsGroup

xMsGroup: undefined | string

The owning group of the file or directory. Included in the response if Hierarchical Namespace is enabled for the account.

Optional xMsOwner

xMsOwner: undefined | string

The owner of the file or directory. Included in the response if Hierarchical Namespace is enabled for the account.

Optional xMsPermissions

xMsPermissions: undefined | string

The POSIX access permissions for the file owner, the file owning group, and others. Included in the response if Hierarchical Namespace is enabled for the account.

serializedName

serializedName: string = "directory-getaccesscontrol-headers"

type

type: object

className

className: string = "DirectoryGetAccessControlHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "x-ms-client-request-id"

type

type: object

name

name: "String" = "String"

date

date: object

serializedName

serializedName: string = "date"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

lastModified

lastModified: object

serializedName

serializedName: string = "last-modified"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

requestId

requestId: object

serializedName

serializedName: string = "x-ms-request-id"

type

type: object

name

name: "String" = "String"

version

version: object

serializedName

serializedName: string = "x-ms-version"

type

type: object

name

name: "String" = "String"

xMsAcl

xMsAcl: object

serializedName

serializedName: string = "x-ms-acl"

type

type: object

name

name: "String" = "String"

xMsGroup

xMsGroup: object

serializedName

serializedName: string = "x-ms-group"

type

type: object

name

name: "String" = "String"

xMsOwner

xMsOwner: object

serializedName

serializedName: string = "x-ms-owner"

type

type: object

name

name: "String" = "String"

xMsPermissions

xMsPermissions: object

serializedName

serializedName: string = "x-ms-permissions"

type

type: object

name

name: "String" = "String"

Const DirectoryHttpHeaders

DirectoryHttpHeaders: object

Additional parameters for a set of operations, such as: Directory_create, Directory_rename, Blob_rename.

Optional cacheControl

cacheControl: undefined | string

Cache control for given resource

Optional contentDisposition

contentDisposition: undefined | string

Content disposition for given resource

Optional contentEncoding

contentEncoding: undefined | string

Content encoding for given resource

Optional contentLanguage

contentLanguage: undefined | string

Content language for given resource

Optional contentType

contentType: undefined | string

Content type for given resource

xmlName

xmlName: string = "directory-http-headers"

type

type: object

className

className: string = "DirectoryHttpHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

cacheControl

cacheControl: object

xmlName

xmlName: string = "cacheControl"

type

type: object

name

name: "String" = "String"

contentDisposition

contentDisposition: object

xmlName

xmlName: string = "contentDisposition"

type

type: object

name

name: "String" = "String"

contentEncoding

contentEncoding: object

xmlName

xmlName: string = "contentEncoding"

type

type: object

name

name: "String" = "String"

contentLanguage

contentLanguage: object

xmlName

xmlName: string = "contentLanguage"

type

type: object

name

name: "String" = "String"

contentType

contentType: object

xmlName

xmlName: string = "contentType"

type

type: object

name

name: "String" = "String"

Const DirectoryRenameHeaders

DirectoryRenameHeaders: object

Defines headers for Rename operation.

Optional clientRequestId

clientRequestId: undefined | string

If a client request id header is sent in the request, this header will be present in the response with the same value.

Optional contentLength

contentLength: undefined | number

The size of the resource in bytes.

Optional date

date: Date

A UTC date/time value generated by the service that indicates the time at which the response was initiated.

Optional eTag

eTag: undefined | string

An HTTP entity tag associated with the file or directory.

Optional lastModified

lastModified: Date

The data and time the file or directory was last modified. Write operations on the file or directory update the last modified time.

Optional marker

marker: undefined | string

When renaming a directory, the number of paths that are renamed with each invocation is limited. If the number of paths to be renamed exceeds this limit, a continuation token is returned in this response header. When a continuation token is returned in the response, it must be specified in a subsequent invocation of the rename operation to continue renaming the directory.

Optional requestId

requestId: undefined | string

A server-generated UUID recorded in the analytics logs for troubleshooting and correlation.

Optional version

version: undefined | string

The version of the REST protocol used to process the request.

serializedName

serializedName: string = "directory-rename-headers"

type

type: object

className

className: string = "DirectoryRenameHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "x-ms-client-request-id"

type

type: object

name

name: "String" = "String"

contentLength

contentLength: object

serializedName

serializedName: string = "content-length"

type

type: object

name

name: "Number" = "Number"

date

date: object

serializedName

serializedName: string = "date"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

lastModified

lastModified: object

serializedName

serializedName: string = "last-modified"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

marker

marker: object

serializedName

serializedName: string = "x-ms-continuation"

type

type: object

name

name: "String" = "String"

requestId

requestId: object

serializedName

serializedName: string = "x-ms-request-id"

type

type: object

name

name: "String" = "String"

version

version: object

serializedName

serializedName: string = "x-ms-version"

type

type: object

name

name: "String" = "String"

Const DirectorySetAccessControlHeaders

DirectorySetAccessControlHeaders: object

Defines headers for SetAccessControl operation.

Optional clientRequestId

clientRequestId: undefined | string

If a client request id header is sent in the request, this header will be present in the response with the same value.

Optional date

date: Date

A UTC date/time value generated by the service that indicates the time at which the response was initiated.

Optional eTag

eTag: undefined | string

An HTTP entity tag associated with the file or directory.

Optional lastModified

lastModified: Date

The data and time the file or directory was last modified. Write operations on the file or directory update the last modified time.

Optional requestId

requestId: undefined | string

A server-generated UUID recorded in the analytics logs for troubleshooting and correlation.

Optional version

version: undefined | string

The version of the REST protocol used to process the request.

serializedName

serializedName: string = "directory-setaccesscontrol-headers"

type

type: object

className

className: string = "DirectorySetAccessControlHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "x-ms-client-request-id"

type

type: object

name

name: "String" = "String"

date

date: object

serializedName

serializedName: string = "date"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

lastModified

lastModified: object

serializedName

serializedName: string = "last-modified"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

requestId

requestId: object

serializedName

serializedName: string = "x-ms-request-id"

type

type: object

name

name: "String" = "String"

version

version: object

serializedName

serializedName: string = "x-ms-version"

type

type: object

name

name: "String" = "String"

Const GeoReplication

GeoReplication: object

Geo-Replication information for the Secondary Storage Service

lastSyncTime

lastSyncTime: Date

A GMT date/time value, to the second. All primary writes preceding this value are guaranteed to be available for read operations at the secondary. Primary writes after this point in time may or may not be available for reads.

status

The status of the secondary location. Possible values include: 'live', 'bootstrap', 'unavailable'

serializedName

serializedName: string = "GeoReplication"

type

type: object

className

className: string = "GeoReplication"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

lastSyncTime

lastSyncTime: object

required

required: true = true

serializedName

serializedName: string = "LastSyncTime"

xmlName

xmlName: string = "LastSyncTime"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

status

status: object

required

required: true = true

serializedName

serializedName: string = "Status"

xmlName

xmlName: string = "Status"

type

type: object

name

name: "String" = "String"

Const HTTPURLConnection

HTTPURLConnection: object

HTTP_ACCEPTED

HTTP_ACCEPTED: number = 202

HTTP_CONFLICT

HTTP_CONFLICT: number = 409

HTTP_NOT_FOUND

HTTP_NOT_FOUND: number = 404

HTTP_PRECON_FAILED

HTTP_PRECON_FAILED: number = 412

HTTP_RANGE_NOT_SATISFIABLE

HTTP_RANGE_NOT_SATISFIABLE: number = 416

Const HeaderConstants

HeaderConstants: object

AUTHORIZATION

AUTHORIZATION: string = "Authorization"

AUTHORIZATION_SCHEME

AUTHORIZATION_SCHEME: string = "Bearer"

CONTENT_ENCODING

CONTENT_ENCODING: string = "Content-Encoding"

CONTENT_ID

CONTENT_ID: string = "Content-ID"

CONTENT_LANGUAGE

CONTENT_LANGUAGE: string = "Content-Language"

CONTENT_LENGTH

CONTENT_LENGTH: string = "Content-Length"

CONTENT_MD5

CONTENT_MD5: string = "Content-Md5"

CONTENT_TRANSFER_ENCODING

CONTENT_TRANSFER_ENCODING: string = "Content-Transfer-Encoding"

CONTENT_TYPE

CONTENT_TYPE: string = "Content-Type"

COOKIE

COOKIE: string = "Cookie"

DATE

DATE: string = "date"

IF_MATCH

IF_MATCH: string = "if-match"

IF_MODIFIED_SINCE

IF_MODIFIED_SINCE: string = "if-modified-since"

IF_NONE_MATCH

IF_NONE_MATCH: string = "if-none-match"

IF_UNMODIFIED_SINCE

IF_UNMODIFIED_SINCE: string = "if-unmodified-since"

PREFIX_FOR_STORAGE

PREFIX_FOR_STORAGE: string = "x-ms-"

RANGE

RANGE: string = "Range"

USER_AGENT

USER_AGENT: string = "User-Agent"

X_MS_CLIENT_REQUEST_ID

X_MS_CLIENT_REQUEST_ID: string = "x-ms-client-request-id"

X_MS_DATE

X_MS_DATE: string = "x-ms-date"

X_MS_ERROR_CODE

X_MS_ERROR_CODE: string = "x-ms-error-code"

X_MS_VERSION

X_MS_VERSION: string = "x-ms-version"

Const KeyInfo

KeyInfo: object

Key information

expiry

expiry: string

The date-time the key expires in ISO 8601 UTC time

start

start: string

The date-time the key is active in ISO 8601 UTC time

serializedName

serializedName: string = "KeyInfo"

type

type: object

className

className: string = "KeyInfo"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

expiry

expiry: object

required

required: true = true

serializedName

serializedName: string = "Expiry"

xmlName

xmlName: string = "Expiry"

type

type: object

name

name: "String" = "String"

start

start: object

required

required: true = true

serializedName

serializedName: string = "Start"

xmlName

xmlName: string = "Start"

type

type: object

name

name: "String" = "String"

Const LeaseAccessConditions

LeaseAccessConditions: object

Additional parameters for a set of operations.

Optional leaseId

leaseId: undefined | string

If specified, the operation only succeeds if the resource's lease is active and matches this ID.

xmlName

xmlName: string = "lease-access-conditions"

type

type: object

className

className: string = "LeaseAccessConditions"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

leaseId

leaseId: object

xmlName

xmlName: string = "leaseId"

type

type: object

name

name: "String" = "String"

Const ListBlobsFlatSegmentResponse

ListBlobsFlatSegmentResponse: object

An enumeration of blobs

containerName

containerName: string

Optional delimiter

delimiter: undefined | string

Optional marker

marker: undefined | string

Optional maxResults

maxResults: undefined | number

Optional nextMarker

nextMarker: undefined | string

Optional prefix

prefix: undefined | string

segment

serviceEndpoint

serviceEndpoint: string

serializedName

serializedName: string = "ListBlobsFlatSegmentResponse"

xmlName

xmlName: string = "EnumerationResults"

type

type: object

className

className: string = "ListBlobsFlatSegmentResponse"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

containerName

containerName: object

required

required: true = true

serializedName

serializedName: string = "ContainerName"

xmlIsAttribute

xmlIsAttribute: true = true

xmlName

xmlName: string = "ContainerName"

type

type: object

name

name: "String" = "String"

delimiter

delimiter: object

serializedName

serializedName: string = "Delimiter"

xmlName

xmlName: string = "Delimiter"

type

type: object

name

name: "String" = "String"

marker

marker: object

serializedName

serializedName: string = "Marker"

xmlName

xmlName: string = "Marker"

type

type: object

name

name: "String" = "String"

maxResults

maxResults: object

serializedName

serializedName: string = "MaxResults"

xmlName

xmlName: string = "MaxResults"

type

type: object

name

name: "Number" = "Number"

nextMarker

nextMarker: object

serializedName

serializedName: string = "NextMarker"

xmlName

xmlName: string = "NextMarker"

type

type: object

name

name: "String" = "String"

prefix

prefix: object

serializedName

serializedName: string = "Prefix"

xmlName

xmlName: string = "Prefix"

type

type: object

name

name: "String" = "String"

segment

segment: object

required

required: true = true

serializedName

serializedName: string = "Segment"

xmlName

xmlName: string = "Blobs"

type

type: object

className

className: string = "BlobFlatListSegment"

name

name: "Composite" = "Composite"

serviceEndpoint

serviceEndpoint: object

required

required: true = true

serializedName

serializedName: string = "ServiceEndpoint"

xmlIsAttribute

xmlIsAttribute: true = true

xmlName

xmlName: string = "ServiceEndpoint"

type

type: object

name

name: "String" = "String"

Const ListBlobsHierarchySegmentResponse

ListBlobsHierarchySegmentResponse: object

An enumeration of blobs

containerName

containerName: string

Optional delimiter

delimiter: undefined | string

Optional marker

marker: undefined | string

Optional maxResults

maxResults: undefined | number

Optional nextMarker

nextMarker: undefined | string

Optional prefix

prefix: undefined | string

segment

serviceEndpoint

serviceEndpoint: string

serializedName

serializedName: string = "ListBlobsHierarchySegmentResponse"

xmlName

xmlName: string = "EnumerationResults"

type

type: object

className

className: string = "ListBlobsHierarchySegmentResponse"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

containerName

containerName: object

required

required: true = true

serializedName

serializedName: string = "ContainerName"

xmlIsAttribute

xmlIsAttribute: true = true

xmlName

xmlName: string = "ContainerName"

type

type: object

name

name: "String" = "String"

delimiter

delimiter: object

serializedName

serializedName: string = "Delimiter"

xmlName

xmlName: string = "Delimiter"

type

type: object

name

name: "String" = "String"

marker

marker: object

serializedName

serializedName: string = "Marker"

xmlName

xmlName: string = "Marker"

type

type: object

name

name: "String" = "String"

maxResults

maxResults: object

serializedName

serializedName: string = "MaxResults"

xmlName

xmlName: string = "MaxResults"

type

type: object

name

name: "Number" = "Number"

nextMarker

nextMarker: object

serializedName

serializedName: string = "NextMarker"

xmlName

xmlName: string = "NextMarker"

type

type: object

name

name: "String" = "String"

prefix

prefix: object

serializedName

serializedName: string = "Prefix"

xmlName

xmlName: string = "Prefix"

type

type: object

name

name: "String" = "String"

segment

segment: object

required

required: true = true

serializedName

serializedName: string = "Segment"

xmlName

xmlName: string = "Blobs"

type

type: object

className

className: string = "BlobHierarchyListSegment"

name

name: "Composite" = "Composite"

serviceEndpoint

serviceEndpoint: object

required

required: true = true

serializedName

serializedName: string = "ServiceEndpoint"

xmlIsAttribute

xmlIsAttribute: true = true

xmlName

xmlName: string = "ServiceEndpoint"

type

type: object

name

name: "String" = "String"

Const ListContainersSegmentResponse

ListContainersSegmentResponse: object

An enumeration of containers

containerItems

containerItems: ContainerItem[]

Optional marker

marker: undefined | string

Optional maxResults

maxResults: undefined | number

Optional nextMarker

nextMarker: undefined | string

Optional prefix

prefix: undefined | string

serviceEndpoint

serviceEndpoint: string

serializedName

serializedName: string = "ListContainersSegmentResponse"

xmlName

xmlName: string = "EnumerationResults"

type

type: object

className

className: string = "ListContainersSegmentResponse"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

containerItems

containerItems: object

required

required: true = true

serializedName

serializedName: string = "ContainerItems"

xmlElementName

xmlElementName: string = "Container"

xmlIsWrapped

xmlIsWrapped: true = true

xmlName

xmlName: string = "Containers"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ContainerItem"

name

name: "Composite" = "Composite"

marker

marker: object

serializedName

serializedName: string = "Marker"

xmlName

xmlName: string = "Marker"

type

type: object

name

name: "String" = "String"

maxResults

maxResults: object

serializedName

serializedName: string = "MaxResults"

xmlName

xmlName: string = "MaxResults"

type

type: object

name

name: "Number" = "Number"

nextMarker

nextMarker: object

serializedName

serializedName: string = "NextMarker"

xmlName

xmlName: string = "NextMarker"

type

type: object

name

name: "String" = "String"

prefix

prefix: object

serializedName

serializedName: string = "Prefix"

xmlName

xmlName: string = "Prefix"

type

type: object

name

name: "String" = "String"

serviceEndpoint

serviceEndpoint: object

required

required: true = true

serializedName

serializedName: string = "ServiceEndpoint"

xmlIsAttribute

xmlIsAttribute: true = true

xmlName

xmlName: string = "ServiceEndpoint"

type

type: object

name

name: "String" = "String"

Const Logging

Logging: object

Azure Analytics Logging settings.

deleteProperty

deleteProperty: boolean

Indicates whether all delete requests should be logged.

read

read: boolean

Indicates whether all read requests should be logged.

retentionPolicy

retentionPolicy: RetentionPolicy

version

version: string

The version of Storage Analytics to configure.

write

write: boolean

Indicates whether all write requests should be logged.

serializedName

serializedName: string = "Logging"

type

type: object

className

className: string = "Logging"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

deleteProperty

deleteProperty: object

required

required: true = true

serializedName

serializedName: string = "Delete"

xmlName

xmlName: string = "Delete"

type

type: object

name

name: "Boolean" = "Boolean"

read

read: object

required

required: true = true

serializedName

serializedName: string = "Read"

xmlName

xmlName: string = "Read"

type

type: object

name

name: "Boolean" = "Boolean"

retentionPolicy

retentionPolicy: object

required

required: true = true

serializedName

serializedName: string = "RetentionPolicy"

xmlName

xmlName: string = "RetentionPolicy"

type

type: object

className

className: string = "RetentionPolicy"

name

name: "Composite" = "Composite"

version

version: object

required

required: true = true

serializedName

serializedName: string = "Version"

xmlName

xmlName: string = "Version"

type

type: object

name

name: "String" = "String"

write

write: object

required

required: true = true

serializedName

serializedName: string = "Write"

xmlName

xmlName: string = "Write"

type

type: object

name

name: "Boolean" = "Boolean"

Const Metrics

Metrics: object

a summary of request statistics grouped by API in hour or minute aggregates for blobs

enabled

enabled: boolean

Indicates whether metrics are enabled for the Blob service.

Optional includeAPIs

includeAPIs: undefined | false | true

Indicates whether metrics should generate summary statistics for called API operations.

Optional retentionPolicy

retentionPolicy: RetentionPolicy

Optional version

version: undefined | string

The version of Storage Analytics to configure.

serializedName

serializedName: string = "Metrics"

type

type: object

className

className: string = "Metrics"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

enabled

enabled: object

required

required: true = true

serializedName

serializedName: string = "Enabled"

xmlName

xmlName: string = "Enabled"

type

type: object

name

name: "Boolean" = "Boolean"

includeAPIs

includeAPIs: object

serializedName

serializedName: string = "IncludeAPIs"

xmlName

xmlName: string = "IncludeAPIs"

type

type: object

name

name: "Boolean" = "Boolean"

retentionPolicy

retentionPolicy: object

serializedName

serializedName: string = "RetentionPolicy"

xmlName

xmlName: string = "RetentionPolicy"

type

type: object

className

className: string = "RetentionPolicy"

name

name: "Composite" = "Composite"

version

version: object

serializedName

serializedName: string = "Version"

xmlName

xmlName: string = "Version"

type

type: object

name

name: "String" = "String"

Const ModifiedAccessConditions

ModifiedAccessConditions: object

Additional parameters for a set of operations.

Optional ifMatch

ifMatch: undefined | string

Specify an ETag value to operate only on blobs with a matching value.

Optional ifModifiedSince

ifModifiedSince: Date

Specify this header value to operate only on a blob if it has been modified since the specified date/time.

Optional ifNoneMatch

ifNoneMatch: undefined | string

Specify an ETag value to operate only on blobs without a matching value.

Optional ifUnmodifiedSince

ifUnmodifiedSince: Date

Specify this header value to operate only on a blob if it has not been modified since the specified date/time.

xmlName

xmlName: string = "modified-access-conditions"

type

type: object

className

className: string = "ModifiedAccessConditions"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

ifMatch

ifMatch: object

xmlName

xmlName: string = "ifMatch"

type

type: object

name

name: "String" = "String"

ifModifiedSince

ifModifiedSince: object

xmlName

xmlName: string = "ifModifiedSince"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

ifNoneMatch

ifNoneMatch: object

xmlName

xmlName: string = "ifNoneMatch"

type

type: object

name

name: "String" = "String"

ifUnmodifiedSince

ifUnmodifiedSince: object

xmlName

xmlName: string = "ifUnmodifiedSince"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const PageBlobClearPagesHeaders

PageBlobClearPagesHeaders: object

Defines headers for ClearPages operation.

Optional blobSequenceNumber

blobSequenceNumber: undefined | number

The current sequence number for the page blob.

Optional clientRequestId

clientRequestId: undefined | string

If a client request id header is sent in the request, this header will be present in the response with the same value.

Optional contentMD5

contentMD5: Uint8Array

If the blob has an MD5 hash and this operation is to read the full blob, this response header is returned so that the client can check for message content integrity.

Optional date

date: Date

UTC date/time value generated by the service that indicates the time at which the response was initiated

Optional eTag

eTag: undefined | string

The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes.

Optional errorCode

errorCode: undefined | string

Optional lastModified

lastModified: Date

Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob.

Optional requestId

requestId: undefined | string

This header uniquely identifies the request that was made and can be used for troubleshooting the request.

Optional version

version: undefined | string

Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above.

Optional xMsContentCrc64

xMsContentCrc64: Uint8Array

This header is returned so that the client can check for message content integrity. The value of this header is computed by the Blob service; it is not necessarily the same value specified in the request headers.

serializedName

serializedName: string = "pageblob-clearpages-headers"

type

type: object

className

className: string = "PageBlobClearPagesHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

blobSequenceNumber

blobSequenceNumber: object

serializedName

serializedName: string = "x-ms-blob-sequence-number"

type

type: object

name

name: "Number" = "Number"

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "x-ms-client-request-id"

type

type: object

name

name: "String" = "String"

contentMD5

contentMD5: object

serializedName

serializedName: string = "content-md5"

type

type: object

name

name: "ByteArray" = "ByteArray"

date

date: object

serializedName

serializedName: string = "date"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

errorCode

errorCode: object

serializedName

serializedName: string = "x-ms-error-code"

type

type: object

name

name: "String" = "String"

lastModified

lastModified: object

serializedName

serializedName: string = "last-modified"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

requestId

requestId: object

serializedName

serializedName: string = "x-ms-request-id"

type

type: object

name

name: "String" = "String"

version

version: object

serializedName

serializedName: string = "x-ms-version"

type

type: object

name

name: "String" = "String"

xMsContentCrc64

xMsContentCrc64: object

serializedName

serializedName: string = "x-ms-content-crc64"

type

type: object

name

name: "ByteArray" = "ByteArray"

Const PageBlobCopyIncrementalHeaders

PageBlobCopyIncrementalHeaders: object

Defines headers for CopyIncremental operation.

Optional clientRequestId

clientRequestId: undefined | string

If a client request id header is sent in the request, this header will be present in the response with the same value.

Optional copyId

copyId: undefined | string

String identifier for this copy operation. Use with Get Blob Properties to check the status of this copy operation, or pass to Abort Copy Blob to abort a pending copy.

Optional copyStatus

copyStatus: CopyStatusType

State of the copy operation identified by x-ms-copy-id. Possible values include: 'pending', 'success', 'aborted', 'failed'

Optional date

date: Date

UTC date/time value generated by the service that indicates the time at which the response was initiated

Optional eTag

eTag: undefined | string

The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes.

Optional errorCode

errorCode: undefined | string

Optional lastModified

lastModified: Date

Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob.

Optional requestId

requestId: undefined | string

This header uniquely identifies the request that was made and can be used for troubleshooting the request.

Optional version

version: undefined | string

Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above.

serializedName

serializedName: string = "pageblob-copyincremental-headers"

type

type: object

className

className: string = "PageBlobCopyIncrementalHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "x-ms-client-request-id"

type

type: object

name

name: "String" = "String"

copyId

copyId: object

serializedName

serializedName: string = "x-ms-copy-id"

type

type: object

name

name: "String" = "String"

copyStatus

copyStatus: object

serializedName

serializedName: string = "x-ms-copy-status"

type

type: object

allowedValues

allowedValues: string[] = ["pending","success","aborted","failed"]

name

name: "Enum" = "Enum"

date

date: object

serializedName

serializedName: string = "date"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

errorCode

errorCode: object

serializedName

serializedName: string = "x-ms-error-code"

type

type: object

name

name: "String" = "String"

lastModified

lastModified: object

serializedName

serializedName: string = "last-modified"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

requestId

requestId: object

serializedName

serializedName: string = "x-ms-request-id"

type

type: object

name

name: "String" = "String"

version

version: object

serializedName

serializedName: string = "x-ms-version"

type

type: object

name

name: "String" = "String"

Const PageBlobCreateHeaders

PageBlobCreateHeaders: object

Defines headers for Create operation.

Optional clientRequestId

clientRequestId: undefined | string

If a client request id header is sent in the request, this header will be present in the response with the same value.

Optional contentMD5

contentMD5: Uint8Array

If the blob has an MD5 hash and this operation is to read the full blob, this response header is returned so that the client can check for message content integrity.

Optional date

date: Date

UTC date/time value generated by the service that indicates the time at which the response was initiated

Optional eTag

eTag: undefined | string

The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes.

Optional encryptionKeySha256

encryptionKeySha256: undefined | string

The SHA-256 hash of the encryption key used to encrypt the blob. This header is only returned when the blob was encrypted with a customer-provided key.

Optional errorCode

errorCode: undefined | string

Optional isServerEncrypted

isServerEncrypted: undefined | false | true

The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise.

Optional lastModified

lastModified: Date

Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob.

Optional requestId

requestId: undefined | string

This header uniquely identifies the request that was made and can be used for troubleshooting the request.

Optional version

version: undefined | string

Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above.

serializedName

serializedName: string = "pageblob-create-headers"

type

type: object

className

className: string = "PageBlobCreateHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "x-ms-client-request-id"

type

type: object

name

name: "String" = "String"

contentMD5

contentMD5: object

serializedName

serializedName: string = "content-md5"

type

type: object

name

name: "ByteArray" = "ByteArray"

date

date: object

serializedName

serializedName: string = "date"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

encryptionKeySha256

encryptionKeySha256: object

serializedName

serializedName: string = "x-ms-encryption-key-sha256"

type

type: object

name

name: "String" = "String"

errorCode

errorCode: object

serializedName

serializedName: string = "x-ms-error-code"

type

type: object

name

name: "String" = "String"

isServerEncrypted

isServerEncrypted: object

serializedName

serializedName: string = "x-ms-request-server-encrypted"

type

type: object

name

name: "Boolean" = "Boolean"

lastModified

lastModified: object

serializedName

serializedName: string = "last-modified"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

requestId

requestId: object

serializedName

serializedName: string = "x-ms-request-id"

type

type: object

name

name: "String" = "String"

version

version: object

serializedName

serializedName: string = "x-ms-version"

type

type: object

name

name: "String" = "String"

Const PageBlobGetPageRangesDiffHeaders

PageBlobGetPageRangesDiffHeaders: object

Defines headers for GetPageRangesDiff operation.

Optional blobContentLength

blobContentLength: undefined | number

The size of the blob in bytes.

Optional clientRequestId

clientRequestId: undefined | string

If a client request id header is sent in the request, this header will be present in the response with the same value.

Optional date

date: Date

UTC date/time value generated by the service that indicates the time at which the response was initiated

Optional eTag

eTag: undefined | string

The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes.

Optional errorCode

errorCode: undefined | string

Optional lastModified

lastModified: Date

Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob.

Optional requestId

requestId: undefined | string

This header uniquely identifies the request that was made and can be used for troubleshooting the request.

Optional version

version: undefined | string

Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above.

serializedName

serializedName: string = "pageblob-getpagerangesdiff-headers"

type

type: object

className

className: string = "PageBlobGetPageRangesDiffHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

blobContentLength

blobContentLength: object

serializedName

serializedName: string = "x-ms-blob-content-length"

type

type: object

name

name: "Number" = "Number"

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "x-ms-client-request-id"

type

type: object

name

name: "String" = "String"

date

date: object

serializedName

serializedName: string = "date"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

errorCode

errorCode: object

serializedName

serializedName: string = "x-ms-error-code"

type

type: object

name

name: "String" = "String"

lastModified

lastModified: object

serializedName

serializedName: string = "last-modified"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

requestId

requestId: object

serializedName

serializedName: string = "x-ms-request-id"

type

type: object

name

name: "String" = "String"

version

version: object

serializedName

serializedName: string = "x-ms-version"

type

type: object

name

name: "String" = "String"

Const PageBlobGetPageRangesHeaders

PageBlobGetPageRangesHeaders: object

Defines headers for GetPageRanges operation.

Optional blobContentLength

blobContentLength: undefined | number

The size of the blob in bytes.

Optional clientRequestId

clientRequestId: undefined | string

If a client request id header is sent in the request, this header will be present in the response with the same value.

Optional date

date: Date

UTC date/time value generated by the service that indicates the time at which the response was initiated

Optional eTag

eTag: undefined | string

The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes.

Optional errorCode

errorCode: undefined | string

Optional lastModified

lastModified: Date

Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob.

Optional requestId

requestId: undefined | string

This header uniquely identifies the request that was made and can be used for troubleshooting the request.

Optional version

version: undefined | string

Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above.

serializedName

serializedName: string = "pageblob-getpageranges-headers"

type

type: object

className

className: string = "PageBlobGetPageRangesHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

blobContentLength

blobContentLength: object

serializedName

serializedName: string = "x-ms-blob-content-length"

type

type: object

name

name: "Number" = "Number"

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "x-ms-client-request-id"

type

type: object

name

name: "String" = "String"

date

date: object

serializedName

serializedName: string = "date"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

errorCode

errorCode: object

serializedName

serializedName: string = "x-ms-error-code"

type

type: object

name

name: "String" = "String"

lastModified

lastModified: object

serializedName

serializedName: string = "last-modified"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

requestId

requestId: object

serializedName

serializedName: string = "x-ms-request-id"

type

type: object

name

name: "String" = "String"

version

version: object

serializedName

serializedName: string = "x-ms-version"

type

type: object

name

name: "String" = "String"

Const PageBlobResizeHeaders

PageBlobResizeHeaders: object

Defines headers for Resize operation.

Optional blobSequenceNumber

blobSequenceNumber: undefined | number

The current sequence number for a page blob. This header is not returned for block blobs or append blobs

Optional clientRequestId

clientRequestId: undefined | string

If a client request id header is sent in the request, this header will be present in the response with the same value.

Optional date

date: Date

UTC date/time value generated by the service that indicates the time at which the response was initiated

Optional eTag

eTag: undefined | string

The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes.

Optional errorCode

errorCode: undefined | string

Optional lastModified

lastModified: Date

Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob.

Optional requestId

requestId: undefined | string

This header uniquely identifies the request that was made and can be used for troubleshooting the request.

Optional version

version: undefined | string

Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above.

serializedName

serializedName: string = "pageblob-resize-headers"

type

type: object

className

className: string = "PageBlobResizeHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

blobSequenceNumber

blobSequenceNumber: object

serializedName

serializedName: string = "x-ms-blob-sequence-number"

type

type: object

name

name: "Number" = "Number"

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "x-ms-client-request-id"

type

type: object

name

name: "String" = "String"

date

date: object

serializedName

serializedName: string = "date"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

errorCode

errorCode: object

serializedName

serializedName: string = "x-ms-error-code"

type

type: object

name

name: "String" = "String"

lastModified

lastModified: object

serializedName

serializedName: string = "last-modified"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

requestId

requestId: object

serializedName

serializedName: string = "x-ms-request-id"

type

type: object

name

name: "String" = "String"

version

version: object

serializedName

serializedName: string = "x-ms-version"

type

type: object

name

name: "String" = "String"

Const PageBlobUpdateSequenceNumberHeaders

PageBlobUpdateSequenceNumberHeaders: object

Defines headers for UpdateSequenceNumber operation.

Optional blobSequenceNumber

blobSequenceNumber: undefined | number

The current sequence number for a page blob. This header is not returned for block blobs or append blobs

Optional clientRequestId

clientRequestId: undefined | string

If a client request id header is sent in the request, this header will be present in the response with the same value.

Optional date

date: Date

UTC date/time value generated by the service that indicates the time at which the response was initiated

Optional eTag

eTag: undefined | string

The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes.

Optional errorCode

errorCode: undefined | string

Optional lastModified

lastModified: Date

Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob.

Optional requestId

requestId: undefined | string

This header uniquely identifies the request that was made and can be used for troubleshooting the request.

Optional version

version: undefined | string

Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above.

serializedName

serializedName: string = "pageblob-updatesequencenumber-headers"

type

type: object

className

className: string = "PageBlobUpdateSequenceNumberHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

blobSequenceNumber

blobSequenceNumber: object

serializedName

serializedName: string = "x-ms-blob-sequence-number"

type

type: object

name

name: "Number" = "Number"

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "x-ms-client-request-id"

type

type: object

name

name: "String" = "String"

date

date: object

serializedName

serializedName: string = "date"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

errorCode

errorCode: object

serializedName

serializedName: string = "x-ms-error-code"

type

type: object

name

name: "String" = "String"

lastModified

lastModified: object

serializedName

serializedName: string = "last-modified"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

requestId

requestId: object

serializedName

serializedName: string = "x-ms-request-id"

type

type: object

name

name: "String" = "String"

version

version: object

serializedName

serializedName: string = "x-ms-version"

type

type: object

name

name: "String" = "String"

Const PageBlobUploadPagesFromURLHeaders

PageBlobUploadPagesFromURLHeaders: object

Defines headers for UploadPagesFromURL operation.

Optional blobSequenceNumber

blobSequenceNumber: undefined | number

The current sequence number for the page blob.

Optional contentMD5

contentMD5: Uint8Array

If the blob has an MD5 hash and this operation is to read the full blob, this response header is returned so that the client can check for message content integrity.

Optional date

date: Date

UTC date/time value generated by the service that indicates the time at which the response was initiated

Optional eTag

eTag: undefined | string

The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes.

Optional encryptionKeySha256

encryptionKeySha256: undefined | string

The SHA-256 hash of the encryption key used to encrypt the pages. This header is only returned when the pages were encrypted with a customer-provided key.

Optional errorCode

errorCode: undefined | string

Optional isServerEncrypted

isServerEncrypted: undefined | false | true

The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise.

Optional lastModified

lastModified: Date

Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob.

Optional requestId

requestId: undefined | string

This header uniquely identifies the request that was made and can be used for troubleshooting the request.

Optional version

version: undefined | string

Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above.

Optional xMsContentCrc64

xMsContentCrc64: Uint8Array

This header is returned so that the client can check for message content integrity. The value of this header is computed by the Blob service; it is not necessarily the same value specified in the request headers.

serializedName

serializedName: string = "pageblob-uploadpagesfromurl-headers"

type

type: object

className

className: string = "PageBlobUploadPagesFromURLHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

blobSequenceNumber

blobSequenceNumber: object

serializedName

serializedName: string = "x-ms-blob-sequence-number"

type

type: object

name

name: "Number" = "Number"

contentMD5

contentMD5: object

serializedName

serializedName: string = "content-md5"

type

type: object

name

name: "ByteArray" = "ByteArray"

date

date: object

serializedName

serializedName: string = "date"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

encryptionKeySha256

encryptionKeySha256: object

serializedName

serializedName: string = "x-ms-encryption-key-sha256"

type

type: object

name

name: "String" = "String"

errorCode

errorCode: object

serializedName

serializedName: string = "x-ms-error-code"

type

type: object

name

name: "String" = "String"

isServerEncrypted

isServerEncrypted: object

serializedName

serializedName: string = "x-ms-request-server-encrypted"

type

type: object

name

name: "Boolean" = "Boolean"

lastModified

lastModified: object

serializedName

serializedName: string = "last-modified"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

requestId

requestId: object

serializedName

serializedName: string = "x-ms-request-id"

type

type: object

name

name: "String" = "String"

version

version: object

serializedName

serializedName: string = "x-ms-version"

type

type: object

name

name: "String" = "String"

xMsContentCrc64

xMsContentCrc64: object

serializedName

serializedName: string = "x-ms-content-crc64"

type

type: object

name

name: "ByteArray" = "ByteArray"

Const PageBlobUploadPagesHeaders

PageBlobUploadPagesHeaders: object

Defines headers for UploadPages operation.

Optional blobSequenceNumber

blobSequenceNumber: undefined | number

The current sequence number for the page blob.

Optional clientRequestId

clientRequestId: undefined | string

If a client request id header is sent in the request, this header will be present in the response with the same value.

Optional contentMD5

contentMD5: Uint8Array

If the blob has an MD5 hash and this operation is to read the full blob, this response header is returned so that the client can check for message content integrity.

Optional date

date: Date

UTC date/time value generated by the service that indicates the time at which the response was initiated

Optional eTag

eTag: undefined | string

The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes.

Optional encryptionKeySha256

encryptionKeySha256: undefined | string

The SHA-256 hash of the encryption key used to encrypt the pages. This header is only returned when the pages were encrypted with a customer-provided key.

Optional errorCode

errorCode: undefined | string

Optional isServerEncrypted

isServerEncrypted: undefined | false | true

The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise.

Optional lastModified

lastModified: Date

Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob.

Optional requestId

requestId: undefined | string

This header uniquely identifies the request that was made and can be used for troubleshooting the request.

Optional version

version: undefined | string

Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above.

Optional xMsContentCrc64

xMsContentCrc64: Uint8Array

This header is returned so that the client can check for message content integrity. The value of this header is computed by the Blob service; it is not necessarily the same value specified in the request headers.

serializedName

serializedName: string = "pageblob-uploadpages-headers"

type

type: object

className

className: string = "PageBlobUploadPagesHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

blobSequenceNumber

blobSequenceNumber: object

serializedName

serializedName: string = "x-ms-blob-sequence-number"

type

type: object

name

name: "Number" = "Number"

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "x-ms-client-request-id"

type

type: object

name

name: "String" = "String"

contentMD5

contentMD5: object

serializedName

serializedName: string = "content-md5"

type

type: object

name

name: "ByteArray" = "ByteArray"

date

date: object

serializedName

serializedName: string = "date"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

encryptionKeySha256

encryptionKeySha256: object

serializedName

serializedName: string = "x-ms-encryption-key-sha256"

type

type: object

name

name: "String" = "String"

errorCode

errorCode: object

serializedName

serializedName: string = "x-ms-error-code"

type

type: object

name

name: "String" = "String"

isServerEncrypted

isServerEncrypted: object

serializedName

serializedName: string = "x-ms-request-server-encrypted"

type

type: object

name

name: "Boolean" = "Boolean"

lastModified

lastModified: object

serializedName

serializedName: string = "last-modified"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

requestId

requestId: object

serializedName

serializedName: string = "x-ms-request-id"

type

type: object

name

name: "String" = "String"

version

version: object

serializedName

serializedName: string = "x-ms-version"

type

type: object

name

name: "String" = "String"

xMsContentCrc64

xMsContentCrc64: object

serializedName

serializedName: string = "x-ms-content-crc64"

type

type: object

name

name: "ByteArray" = "ByteArray"

Const PageList

PageList: object

the list of pages

Optional clearRange

clearRange: ClearRange[]

Optional pageRange

pageRange: PageRange[]

serializedName

serializedName: string = "PageList"

type

type: object

className

className: string = "PageList"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clearRange

clearRange: object

serializedName

serializedName: string = "ClearRange"

xmlElementName

xmlElementName: string = "ClearRange"

xmlName

xmlName: string = "ClearRange"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ClearRange"

name

name: "Composite" = "Composite"

pageRange

pageRange: object

serializedName

serializedName: string = "PageRange"

xmlElementName

xmlElementName: string = "PageRange"

xmlName

xmlName: string = "PageRange"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "PageRange"

name

name: "Composite" = "Composite"

Const PageRange

PageRange: object

An interface representing PageRange.

end

end: number

start

start: number

serializedName

serializedName: string = "PageRange"

type

type: object

className

className: string = "PageRange"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

end

end: object

required

required: true = true

serializedName

serializedName: string = "End"

xmlName

xmlName: string = "End"

type

type: object

name

name: "Number" = "Number"

start

start: object

required

required: true = true

serializedName

serializedName: string = "Start"

xmlName

xmlName: string = "Start"

type

type: object

name

name: "Number" = "Number"

Const RetentionPolicy

RetentionPolicy: object

the retention policy which determines how long the associated data should persist

Optional days

days: undefined | number

Indicates the number of days that metrics or logging or soft-deleted data should be retained. All data older than this value will be deleted

enabled

enabled: boolean

Indicates whether a retention policy is enabled for the storage service

serializedName

serializedName: string = "RetentionPolicy"

type

type: object

className

className: string = "RetentionPolicy"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

days

days: object

serializedName

serializedName: string = "Days"

xmlName

xmlName: string = "Days"

constraints

constraints: object

InclusiveMinimum

InclusiveMinimum: number = 1

type

type: object

name

name: "Number" = "Number"

enabled

enabled: object

required

required: true = true

serializedName

serializedName: string = "Enabled"

xmlName

xmlName: string = "Enabled"

type

type: object

name

name: "Boolean" = "Boolean"

Const SequenceNumberAccessConditions

SequenceNumberAccessConditions: object

Additional parameters for a set of operations, such as: PageBlob_uploadPages, PageBlob_clearPages, PageBlob_uploadPagesFromURL.

Optional ifSequenceNumberEqualTo

ifSequenceNumberEqualTo: undefined | number

Specify this header value to operate only on a blob if it has the specified sequence number.

Optional ifSequenceNumberLessThan

ifSequenceNumberLessThan: undefined | number

Specify this header value to operate only on a blob if it has a sequence number less than the specified.

Optional ifSequenceNumberLessThanOrEqualTo

ifSequenceNumberLessThanOrEqualTo: undefined | number

Specify this header value to operate only on a blob if it has a sequence number less than or equal to the specified.

xmlName

xmlName: string = "sequence-number-access-conditions"

type

type: object

className

className: string = "SequenceNumberAccessConditions"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

ifSequenceNumberEqualTo

ifSequenceNumberEqualTo: object

xmlName

xmlName: string = "ifSequenceNumberEqualTo"

type

type: object

name

name: "Number" = "Number"

ifSequenceNumberLessThan

ifSequenceNumberLessThan: object

xmlName

xmlName: string = "ifSequenceNumberLessThan"

type

type: object

name

name: "Number" = "Number"

ifSequenceNumberLessThanOrEqualTo

ifSequenceNumberLessThanOrEqualTo: object

xmlName

xmlName: string = "ifSequenceNumberLessThanOrEqualTo"

type

type: object

name

name: "Number" = "Number"

Const ServiceGetAccountInfoHeaders

ServiceGetAccountInfoHeaders: object

Defines headers for GetAccountInfo operation.

Optional accountKind

accountKind: AccountKind

Identifies the account kind. Possible values include: 'Storage', 'BlobStorage', 'StorageV2'

Optional clientRequestId

clientRequestId: undefined | string

If a client request id header is sent in the request, this header will be present in the response with the same value.

Optional date

date: Date

UTC date/time value generated by the service that indicates the time at which the response was initiated

Optional errorCode

errorCode: undefined | string

Optional requestId

requestId: undefined | string

This header uniquely identifies the request that was made and can be used for troubleshooting the request.

Optional skuName

skuName: SkuName

Identifies the sku name of the account. Possible values include: 'Standard_LRS', 'Standard_GRS', 'Standard_RAGRS', 'Standard_ZRS', 'Premium_LRS'

Optional version

version: undefined | string

Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above.

serializedName

serializedName: string = "service-getaccountinfo-headers"

type

type: object

className

className: string = "ServiceGetAccountInfoHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

accountKind

accountKind: object

serializedName

serializedName: string = "x-ms-account-kind"

type

type: object

allowedValues

allowedValues: string[] = ["Storage","BlobStorage","StorageV2"]

name

name: "Enum" = "Enum"

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "x-ms-client-request-id"

type

type: object

name

name: "String" = "String"

date

date: object

serializedName

serializedName: string = "date"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

errorCode

errorCode: object

serializedName

serializedName: string = "x-ms-error-code"

type

type: object

name

name: "String" = "String"

requestId

requestId: object

serializedName

serializedName: string = "x-ms-request-id"

type

type: object

name

name: "String" = "String"

skuName

skuName: object

serializedName

serializedName: string = "x-ms-sku-name"

type

type: object

allowedValues

allowedValues: string[] = ["Standard_LRS","Standard_GRS","Standard_RAGRS","Standard_ZRS","Premium_LRS"]

name

name: "Enum" = "Enum"

version

version: object

serializedName

serializedName: string = "x-ms-version"

type

type: object

name

name: "String" = "String"

Const ServiceGetPropertiesHeaders

ServiceGetPropertiesHeaders: object

Defines headers for GetProperties operation.

Optional clientRequestId

clientRequestId: undefined | string

If a client request id header is sent in the request, this header will be present in the response with the same value.

Optional errorCode

errorCode: undefined | string

Optional requestId

requestId: undefined | string

This header uniquely identifies the request that was made and can be used for troubleshooting the request.

Optional version

version: undefined | string

Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above.

serializedName

serializedName: string = "service-getproperties-headers"

type

type: object

className

className: string = "ServiceGetPropertiesHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "x-ms-client-request-id"

type

type: object

name

name: "String" = "String"

errorCode

errorCode: object

serializedName

serializedName: string = "x-ms-error-code"

type

type: object

name

name: "String" = "String"

requestId

requestId: object

serializedName

serializedName: string = "x-ms-request-id"

type

type: object

name

name: "String" = "String"

version

version: object

serializedName

serializedName: string = "x-ms-version"

type

type: object

name

name: "String" = "String"

Const ServiceGetStatisticsHeaders

ServiceGetStatisticsHeaders: object

Defines headers for GetStatistics operation.

Optional clientRequestId

clientRequestId: undefined | string

If a client request id header is sent in the request, this header will be present in the response with the same value.

Optional date

date: Date

UTC date/time value generated by the service that indicates the time at which the response was initiated

Optional errorCode

errorCode: undefined | string

Optional requestId

requestId: undefined | string

This header uniquely identifies the request that was made and can be used for troubleshooting the request.

Optional version

version: undefined | string

Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above.

serializedName

serializedName: string = "service-getstatistics-headers"

type

type: object

className

className: string = "ServiceGetStatisticsHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "x-ms-client-request-id"

type

type: object

name

name: "String" = "String"

date

date: object

serializedName

serializedName: string = "date"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

errorCode

errorCode: object

serializedName

serializedName: string = "x-ms-error-code"

type

type: object

name

name: "String" = "String"

requestId

requestId: object

serializedName

serializedName: string = "x-ms-request-id"

type

type: object

name

name: "String" = "String"

version

version: object

serializedName

serializedName: string = "x-ms-version"

type

type: object

name

name: "String" = "String"

Const ServiceGetUserDelegationKeyHeaders

ServiceGetUserDelegationKeyHeaders: object

Defines headers for GetUserDelegationKey operation.

Optional clientRequestId

clientRequestId: undefined | string

If a client request id header is sent in the request, this header will be present in the response with the same value.

Optional date

date: Date

UTC date/time value generated by the service that indicates the time at which the response was initiated

Optional errorCode

errorCode: undefined | string

Optional requestId

requestId: undefined | string

This header uniquely identifies the request that was made and can be used for troubleshooting the request.

Optional version

version: undefined | string

Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above.

serializedName

serializedName: string = "service-getuserdelegationkey-headers"

type

type: object

className

className: string = "ServiceGetUserDelegationKeyHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "x-ms-client-request-id"

type

type: object

name

name: "String" = "String"

date

date: object

serializedName

serializedName: string = "date"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

errorCode

errorCode: object

serializedName

serializedName: string = "x-ms-error-code"

type

type: object

name

name: "String" = "String"

requestId

requestId: object

serializedName

serializedName: string = "x-ms-request-id"

type

type: object

name

name: "String" = "String"

version

version: object

serializedName

serializedName: string = "x-ms-version"

type

type: object

name

name: "String" = "String"

Const ServiceListContainersSegmentHeaders

ServiceListContainersSegmentHeaders: object

Defines headers for ListContainersSegment operation.

Optional clientRequestId

clientRequestId: undefined | string

If a client request id header is sent in the request, this header will be present in the response with the same value.

Optional errorCode

errorCode: undefined | string

Optional requestId

requestId: undefined | string

This header uniquely identifies the request that was made and can be used for troubleshooting the request.

Optional version

version: undefined | string

Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above.

serializedName

serializedName: string = "service-listcontainerssegment-headers"

type

type: object

className

className: string = "ServiceListContainersSegmentHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "x-ms-client-request-id"

type

type: object

name

name: "String" = "String"

errorCode

errorCode: object

serializedName

serializedName: string = "x-ms-error-code"

type

type: object

name

name: "String" = "String"

requestId

requestId: object

serializedName

serializedName: string = "x-ms-request-id"

type

type: object

name

name: "String" = "String"

version

version: object

serializedName

serializedName: string = "x-ms-version"

type

type: object

name

name: "String" = "String"

Const ServiceSetPropertiesHeaders

ServiceSetPropertiesHeaders: object

Defines headers for SetProperties operation.

Optional clientRequestId

clientRequestId: undefined | string

If a client request id header is sent in the request, this header will be present in the response with the same value.

Optional errorCode

errorCode: undefined | string

Optional requestId

requestId: undefined | string

This header uniquely identifies the request that was made and can be used for troubleshooting the request.

Optional version

version: undefined | string

Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above.

serializedName

serializedName: string = "service-setproperties-headers"

type

type: object

className

className: string = "ServiceSetPropertiesHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "x-ms-client-request-id"

type

type: object

name

name: "String" = "String"

errorCode

errorCode: object

serializedName

serializedName: string = "x-ms-error-code"

type

type: object

name

name: "String" = "String"

requestId

requestId: object

serializedName

serializedName: string = "x-ms-request-id"

type

type: object

name

name: "String" = "String"

version

version: object

serializedName

serializedName: string = "x-ms-version"

type

type: object

name

name: "String" = "String"

Const ServiceSubmitBatchHeaders

ServiceSubmitBatchHeaders: object

Defines headers for SubmitBatch operation.

Optional clientRequestId

clientRequestId: undefined | string

If a client request id header is sent in the request, this header will be present in the response with the same value.

Optional contentType

contentType: undefined | string

The media type of the body of the response. For batch requests, this is multipart/mixed; boundary=batchresponse_GUID

Optional errorCode

errorCode: undefined | string

Optional requestId

requestId: undefined | string

This header uniquely identifies the request that was made and can be used for troubleshooting the request.

Optional version

version: undefined | string

Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above.

serializedName

serializedName: string = "service-submitbatch-headers"

type

type: object

className

className: string = "ServiceSubmitBatchHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "x-ms-client-request-id"

type

type: object

name

name: "String" = "String"

contentType

contentType: object

serializedName

serializedName: string = "content-type"

type

type: object

name

name: "String" = "String"

errorCode

errorCode: object

serializedName

serializedName: string = "x-ms-error-code"

type

type: object

name

name: "String" = "String"

requestId

requestId: object

serializedName

serializedName: string = "x-ms-request-id"

type

type: object

name

name: "String" = "String"

version

version: object

serializedName

serializedName: string = "x-ms-version"

type

type: object

name

name: "String" = "String"

Const SignedIdentifier

SignedIdentifier: object

signed identifier

accessPolicy

accessPolicy: AccessPolicy

id

id: string

a unique id

serializedName

serializedName: string = "SignedIdentifier"

type

type: object

className

className: string = "SignedIdentifier"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

accessPolicy

accessPolicy: object

required

required: true = true

serializedName

serializedName: string = "AccessPolicy"

xmlName

xmlName: string = "AccessPolicy"

type

type: object

className

className: string = "AccessPolicy"

name

name: "Composite" = "Composite"

id

id: object

required

required: true = true

serializedName

serializedName: string = "Id"

xmlName

xmlName: string = "Id"

type

type: object

name

name: "String" = "String"

Const SourceModifiedAccessConditions

SourceModifiedAccessConditions: object

Additional parameters for a set of operations.

Optional sourceIfMatch

sourceIfMatch: undefined | string

Specify an ETag value to operate only on blobs with a matching value.

Optional sourceIfModifiedSince

sourceIfModifiedSince: Date

Specify this header value to operate only on a blob if it has been modified since the specified date/time.

Optional sourceIfNoneMatch

sourceIfNoneMatch: undefined | string

Specify an ETag value to operate only on blobs without a matching value.

Optional sourceIfUnmodifiedSince

sourceIfUnmodifiedSince: Date

Specify this header value to operate only on a blob if it has not been modified since the specified date/time.

xmlName

xmlName: string = "source-modified-access-conditions"

type

type: object

className

className: string = "SourceModifiedAccessConditions"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

sourceIfMatch

sourceIfMatch: object

xmlName

xmlName: string = "sourceIfMatch"

type

type: object

name

name: "String" = "String"

sourceIfModifiedSince

sourceIfModifiedSince: object

xmlName

xmlName: string = "sourceIfModifiedSince"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

sourceIfNoneMatch

sourceIfNoneMatch: object

xmlName

xmlName: string = "sourceIfNoneMatch"

type

type: object

name

name: "String" = "String"

sourceIfUnmodifiedSince

sourceIfUnmodifiedSince: object

xmlName

xmlName: string = "sourceIfUnmodifiedSince"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const StaticWebsite

StaticWebsite: object

The properties that enable an account to host a static website

enabled

enabled: boolean

Indicates whether this account is hosting a static website

Optional errorDocument404Path

errorDocument404Path: undefined | string

The absolute path of the custom 404 page

Optional indexDocument

indexDocument: undefined | string

The default name of the index page under each directory

serializedName

serializedName: string = "StaticWebsite"

type

type: object

className

className: string = "StaticWebsite"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

enabled

enabled: object

required

required: true = true

serializedName

serializedName: string = "Enabled"

xmlName

xmlName: string = "Enabled"

type

type: object

name

name: "Boolean" = "Boolean"

errorDocument404Path

errorDocument404Path: object

serializedName

serializedName: string = "ErrorDocument404Path"

xmlName

xmlName: string = "ErrorDocument404Path"

type

type: object

name

name: "String" = "String"

indexDocument

indexDocument: object

serializedName

serializedName: string = "IndexDocument"

xmlName

xmlName: string = "IndexDocument"

type

type: object

name

name: "String" = "String"

Const StorageError

StorageError: object

An interface representing StorageError.

Optional message

message: undefined | string

serializedName

serializedName: string = "StorageError"

type

type: object

className

className: string = "StorageError"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

message

message: object

serializedName

serializedName: string = "Message"

xmlName

xmlName: string = "Message"

type

type: object

name

name: "String" = "String"

Const StorageServiceProperties

StorageServiceProperties: object

Storage Service Properties.

Optional cors

cors: CorsRule[]

The set of CORS rules.

Optional defaultServiceVersion

defaultServiceVersion: undefined | string

The default version to use for requests to the Blob service if an incoming request's version is not specified. Possible values include version 2008-10-27 and all more recent versions

Optional deleteRetentionPolicy

deleteRetentionPolicy: RetentionPolicy

Optional hourMetrics

hourMetrics: Metrics

Optional logging

logging: Logging

Optional minuteMetrics

minuteMetrics: Metrics

Optional staticWebsite

staticWebsite: StaticWebsite

serializedName

serializedName: string = "StorageServiceProperties"

type

type: object

className

className: string = "StorageServiceProperties"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

cors

cors: object

serializedName

serializedName: string = "Cors"

xmlElementName

xmlElementName: string = "CorsRule"

xmlIsWrapped

xmlIsWrapped: true = true

xmlName

xmlName: string = "Cors"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "CorsRule"

name

name: "Composite" = "Composite"

defaultServiceVersion

defaultServiceVersion: object

serializedName

serializedName: string = "DefaultServiceVersion"

xmlName

xmlName: string = "DefaultServiceVersion"

type

type: object

name

name: "String" = "String"

deleteRetentionPolicy

deleteRetentionPolicy: object

serializedName

serializedName: string = "DeleteRetentionPolicy"

xmlName

xmlName: string = "DeleteRetentionPolicy"

type

type: object

className

className: string = "RetentionPolicy"

name

name: "Composite" = "Composite"

hourMetrics

hourMetrics: object

serializedName

serializedName: string = "HourMetrics"

xmlName

xmlName: string = "HourMetrics"

type

type: object

className

className: string = "Metrics"

name

name: "Composite" = "Composite"

logging

logging: object

serializedName

serializedName: string = "Logging"

xmlName

xmlName: string = "Logging"

type

type: object

className

className: string = "Logging"

name

name: "Composite" = "Composite"

minuteMetrics

minuteMetrics: object

serializedName

serializedName: string = "MinuteMetrics"

xmlName

xmlName: string = "MinuteMetrics"

type

type: object

className

className: string = "Metrics"

name

name: "Composite" = "Composite"

staticWebsite

staticWebsite: object

serializedName

serializedName: string = "StaticWebsite"

xmlName

xmlName: string = "StaticWebsite"

type

type: object

className

className: string = "StaticWebsite"

name

name: "Composite" = "Composite"

Const StorageServiceStats

StorageServiceStats: object

Stats for the storage service.

Optional geoReplication

geoReplication: GeoReplication

serializedName

serializedName: string = "StorageServiceStats"

type

type: object

className

className: string = "StorageServiceStats"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

geoReplication

geoReplication: object

serializedName

serializedName: string = "GeoReplication"

xmlName

xmlName: string = "GeoReplication"

type

type: object

className

className: string = "GeoReplication"

name

name: "Composite" = "Composite"

Const URLConstants

URLConstants: object

Parameters

Parameters: object

FORCE_BROWSER_NO_CACHE

FORCE_BROWSER_NO_CACHE: string = "_"

SIGNATURE

SIGNATURE: string = "sig"

SNAPSHOT

SNAPSHOT: string = "snapshot"

TIMEOUT

TIMEOUT: string = "timeout"

Const UserDelegationKey

UserDelegationKey: object

A user delegation key

signedExpiry

signedExpiry: string

The date-time the key expires NOTE: This entity will be treated as a string instead of a Date because the API can potentially deal with a higher precision value than what is supported by JavaScript. The date-time the key expires.

type

{Date}

memberof

UserDelegationKey

signedOid

signedOid: string

The Azure Active Directory object ID in GUID format. The Azure Active Directory object ID in GUID format.

type

{string}

memberof

UserDelegationKey

signedService

signedService: string

Abbreviation of the Azure Storage service that accepts the key Abbreviation of the Azure Storage service that accepts the key.

type

{string}

memberof

UserDelegationKey

signedStart

signedStart: string

The date-time the key is active NOTE: This entity will be treated as a string instead of a Date because the API can potentially deal with a higher precision value than what is supported by JavaScript. The date-time the key is active.

type

{Date}

memberof

UserDelegationKey

signedTid

signedTid: string

The Azure Active Directory tenant ID in GUID format The Azure Active Directory tenant ID in GUID format.

type

{string}

memberof

UserDelegationKey

signedVersion

signedVersion: string

The service version that created the key The service version that created the key.

type

{string}

memberof

UserDelegationKey

value

value: string

The key as a base64 string The key as a base64 string.

type

{string}

memberof

UserDelegationKey

serializedName

serializedName: string = "UserDelegationKey"

type

type: object

className

className: string = "UserDelegationKey"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

signedExpiry

signedExpiry: object

required

required: true = true

serializedName

serializedName: string = "SignedExpiry"

xmlName

xmlName: string = "SignedExpiry"

type

type: object

name

name: "String" = "String"

signedOid

signedOid: object

required

required: true = true

serializedName

serializedName: string = "SignedOid"

xmlName

xmlName: string = "SignedOid"

type

type: object

name

name: "String" = "String"

signedService

signedService: object

required

required: true = true

serializedName

serializedName: string = "SignedService"

xmlName

xmlName: string = "SignedService"

type

type: object

name

name: "String" = "String"

signedStart

signedStart: object

required

required: true = true

serializedName

serializedName: string = "SignedStart"

xmlName

xmlName: string = "SignedStart"

type

type: object

name

name: "String" = "String"

signedTid

signedTid: object

required

required: true = true

serializedName

serializedName: string = "SignedTid"

xmlName

xmlName: string = "SignedTid"

type

type: object

name

name: "String" = "String"

signedVersion

signedVersion: object

required

required: true = true

serializedName

serializedName: string = "SignedVersion"

xmlName

xmlName: string = "SignedVersion"

type

type: object

name

name: "String" = "String"

value

value: object

required

required: true = true

serializedName

serializedName: string = "Value"

xmlName

xmlName: string = "Value"

type

type: object

name

name: "String" = "String"

Const access

access: object

parameterPath

parameterPath: string[] = ["options","access"]

mapper

mapper: object

serializedName

serializedName: string = "x-ms-blob-public-access"

type

type: object

name

name: "String" = "String"

Const action0

action0: object

parameterPath

parameterPath: string = "action"

mapper

mapper: object

defaultValue

defaultValue: string = "acquire"

isConstant

isConstant: true = true

required

required: true = true

serializedName

serializedName: string = "x-ms-lease-action"

type

type: object

name

name: "String" = "String"

Const action1

action1: object

parameterPath

parameterPath: string = "action"

mapper

mapper: object

defaultValue

defaultValue: string = "release"

isConstant

isConstant: true = true

required

required: true = true

serializedName

serializedName: string = "x-ms-lease-action"

type

type: object

name

name: "String" = "String"

Const action2

action2: object

parameterPath

parameterPath: string = "action"

mapper

mapper: object

defaultValue

defaultValue: string = "renew"

isConstant

isConstant: true = true

required

required: true = true

serializedName

serializedName: string = "x-ms-lease-action"

type

type: object

name

name: "String" = "String"

Const action3

action3: object

parameterPath

parameterPath: string = "action"

mapper

mapper: object

defaultValue

defaultValue: string = "break"

isConstant

isConstant: true = true

required

required: true = true

serializedName

serializedName: string = "x-ms-lease-action"

type

type: object

name

name: "String" = "String"

Const action4

action4: object

parameterPath

parameterPath: string = "action"

mapper

mapper: object

defaultValue

defaultValue: string = "change"

isConstant

isConstant: true = true

required

required: true = true

serializedName

serializedName: string = "x-ms-lease-action"

type

type: object

name

name: "String" = "String"

Const action5

action5: object

parameterPath

parameterPath: string = "action"

mapper

mapper: object

defaultValue

defaultValue: string = "setAccessControl"

isConstant

isConstant: true = true

required

required: true = true

serializedName

serializedName: string = "action"

type

type: object

name

name: "String" = "String"

Const action6

action6: object

parameterPath

parameterPath: string = "action"

mapper

mapper: object

defaultValue

defaultValue: string = "getAccessControl"

isConstant

isConstant: true = true

required

required: true = true

serializedName

serializedName: string = "action"

type

type: object

name

name: "String" = "String"

Const appendPosition

appendPosition: object

parameterPath

parameterPath: string[] = ["options","appendPositionAccessConditions","appendPosition"]

mapper

mapper: object

serializedName

serializedName: string = "x-ms-blob-condition-appendpos"

type

type: object

name

name: "Number" = "Number"

Const blobCacheControl

blobCacheControl: object

parameterPath

parameterPath: string[] = ["options","blobHTTPHeaders","blobCacheControl"]

mapper

mapper: object

serializedName

serializedName: string = "x-ms-blob-cache-control"

type

type: object

name

name: "String" = "String"

Const blobContentDisposition

blobContentDisposition: object

parameterPath

parameterPath: string[] = ["options","blobHTTPHeaders","blobContentDisposition"]

mapper

mapper: object

serializedName

serializedName: string = "x-ms-blob-content-disposition"

type

type: object

name

name: "String" = "String"

Const blobContentEncoding

blobContentEncoding: object

parameterPath

parameterPath: string[] = ["options","blobHTTPHeaders","blobContentEncoding"]

mapper

mapper: object

serializedName

serializedName: string = "x-ms-blob-content-encoding"

type

type: object

name

name: "String" = "String"

Const blobContentLanguage

blobContentLanguage: object

parameterPath

parameterPath: string[] = ["options","blobHTTPHeaders","blobContentLanguage"]

mapper

mapper: object

serializedName

serializedName: string = "x-ms-blob-content-language"

type

type: object

name

name: "String" = "String"

Const blobContentLength

blobContentLength: object

parameterPath

parameterPath: string = "blobContentLength"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "x-ms-blob-content-length"

type

type: object

name

name: "Number" = "Number"

Const blobContentMD5

blobContentMD5: object

parameterPath

parameterPath: string[] = ["options","blobHTTPHeaders","blobContentMD5"]

mapper

mapper: object

serializedName

serializedName: string = "x-ms-blob-content-md5"

type

type: object

name

name: "ByteArray" = "ByteArray"

Const blobContentType

blobContentType: object

parameterPath

parameterPath: string[] = ["options","blobHTTPHeaders","blobContentType"]

mapper

mapper: object

serializedName

serializedName: string = "x-ms-blob-content-type"

type

type: object

name

name: "String" = "String"

Const blobSequenceNumber

blobSequenceNumber: object

parameterPath

parameterPath: string[] = ["options","blobSequenceNumber"]

mapper

mapper: object

defaultValue

defaultValue: number = 0

serializedName

serializedName: string = "x-ms-blob-sequence-number"

type

type: object

name

name: "Number" = "Number"

Const blobType0

blobType0: object

parameterPath

parameterPath: string = "blobType"

mapper

mapper: object

defaultValue

defaultValue: string = "PageBlob"

isConstant

isConstant: true = true

required

required: true = true

serializedName

serializedName: string = "x-ms-blob-type"

type

type: object

name

name: "String" = "String"

Const blobType1

blobType1: object

parameterPath

parameterPath: string = "blobType"

mapper

mapper: object

defaultValue

defaultValue: string = "AppendBlob"

isConstant

isConstant: true = true

required

required: true = true

serializedName

serializedName: string = "x-ms-blob-type"

type

type: object

name

name: "String" = "String"

Const blobType2

blobType2: object

parameterPath

parameterPath: string = "blobType"

mapper

mapper: object

defaultValue

defaultValue: string = "BlockBlob"

isConstant

isConstant: true = true

required

required: true = true

serializedName

serializedName: string = "x-ms-blob-type"

type

type: object

name

name: "String" = "String"

Const blockId

blockId: object

parameterPath

parameterPath: string = "blockId"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "blockid"

type

type: object

name

name: "String" = "String"

Const breakPeriod

breakPeriod: object

parameterPath

parameterPath: string[] = ["options","breakPeriod"]

mapper

mapper: object

serializedName

serializedName: string = "x-ms-lease-break-period"

type

type: object

name

name: "Number" = "Number"

Const cacheControl

cacheControl: object

parameterPath

parameterPath: string[] = ["options","directoryHttpHeaders","cacheControl"]

mapper

mapper: object

serializedName

serializedName: string = "x-ms-cache-control"

type

type: object

name

name: "String" = "String"

Const comp0

comp0: object

parameterPath

parameterPath: string = "comp"

mapper

mapper: object

defaultValue

defaultValue: string = "properties"

isConstant

isConstant: true = true

required

required: true = true

serializedName

serializedName: string = "comp"

type

type: object

name

name: "String" = "String"

Const comp1

comp1: object

parameterPath

parameterPath: string = "comp"

mapper

mapper: object

defaultValue

defaultValue: string = "stats"

isConstant

isConstant: true = true

required

required: true = true

serializedName

serializedName: string = "comp"

type

type: object

name

name: "String" = "String"

Const comp10

comp10: object

parameterPath

parameterPath: string = "comp"

mapper

mapper: object

defaultValue

defaultValue: string = "copy"

isConstant

isConstant: true = true

required

required: true = true

serializedName

serializedName: string = "comp"

type

type: object

name

name: "String" = "String"

Const comp11

comp11: object

parameterPath

parameterPath: string = "comp"

mapper

mapper: object

defaultValue

defaultValue: string = "tier"

isConstant

isConstant: true = true

required

required: true = true

serializedName

serializedName: string = "comp"

type

type: object

name

name: "String" = "String"

Const comp12

comp12: object

parameterPath

parameterPath: string = "comp"

mapper

mapper: object

defaultValue

defaultValue: string = "page"

isConstant

isConstant: true = true

required

required: true = true

serializedName

serializedName: string = "comp"

type

type: object

name

name: "String" = "String"

Const comp13

comp13: object

parameterPath

parameterPath: string = "comp"

mapper

mapper: object

defaultValue

defaultValue: string = "pagelist"

isConstant

isConstant: true = true

required

required: true = true

serializedName

serializedName: string = "comp"

type

type: object

name

name: "String" = "String"

Const comp14

comp14: object

parameterPath

parameterPath: string = "comp"

mapper

mapper: object

defaultValue

defaultValue: string = "incrementalcopy"

isConstant

isConstant: true = true

required

required: true = true

serializedName

serializedName: string = "comp"

type

type: object

name

name: "String" = "String"

Const comp15

comp15: object

parameterPath

parameterPath: string = "comp"

mapper

mapper: object

defaultValue

defaultValue: string = "appendblock"

isConstant

isConstant: true = true

required

required: true = true

serializedName

serializedName: string = "comp"

type

type: object

name

name: "String" = "String"

Const comp16

comp16: object

parameterPath

parameterPath: string = "comp"

mapper

mapper: object

defaultValue

defaultValue: string = "block"

isConstant

isConstant: true = true

required

required: true = true

serializedName

serializedName: string = "comp"

type

type: object

name

name: "String" = "String"

Const comp17

comp17: object

parameterPath

parameterPath: string = "comp"

mapper

mapper: object

defaultValue

defaultValue: string = "blocklist"

isConstant

isConstant: true = true

required

required: true = true

serializedName

serializedName: string = "comp"

type

type: object

name

name: "String" = "String"

Const comp2

comp2: object

parameterPath

parameterPath: string = "comp"

mapper

mapper: object

defaultValue

defaultValue: string = "list"

isConstant

isConstant: true = true

required

required: true = true

serializedName

serializedName: string = "comp"

type

type: object

name

name: "String" = "String"

Const comp3

comp3: object

parameterPath

parameterPath: string = "comp"

mapper

mapper: object

defaultValue

defaultValue: string = "userdelegationkey"

isConstant

isConstant: true = true

required

required: true = true

serializedName

serializedName: string = "comp"

type

type: object

name

name: "String" = "String"

Const comp4

comp4: object

parameterPath

parameterPath: string = "comp"

mapper

mapper: object

defaultValue

defaultValue: string = "batch"

isConstant

isConstant: true = true

required

required: true = true

serializedName

serializedName: string = "comp"

type

type: object

name

name: "String" = "String"

Const comp5

comp5: object

parameterPath

parameterPath: string = "comp"

mapper

mapper: object

defaultValue

defaultValue: string = "metadata"

isConstant

isConstant: true = true

required

required: true = true

serializedName

serializedName: string = "comp"

type

type: object

name

name: "String" = "String"

Const comp6

comp6: object

parameterPath

parameterPath: string = "comp"

mapper

mapper: object

defaultValue

defaultValue: string = "acl"

isConstant

isConstant: true = true

required

required: true = true

serializedName

serializedName: string = "comp"

type

type: object

name

name: "String" = "String"

Const comp7

comp7: object

parameterPath

parameterPath: string = "comp"

mapper

mapper: object

defaultValue

defaultValue: string = "lease"

isConstant

isConstant: true = true

required

required: true = true

serializedName

serializedName: string = "comp"

type

type: object

name

name: "String" = "String"

Const comp8

comp8: object

parameterPath

parameterPath: string = "comp"

mapper

mapper: object

defaultValue

defaultValue: string = "undelete"

isConstant

isConstant: true = true

required

required: true = true

serializedName

serializedName: string = "comp"

type

type: object

name

name: "String" = "String"

Const comp9

comp9: object

parameterPath

parameterPath: string = "comp"

mapper

mapper: object

defaultValue

defaultValue: string = "snapshot"

isConstant

isConstant: true = true

required

required: true = true

serializedName

serializedName: string = "comp"

type

type: object

name

name: "String" = "String"

Const contentDisposition

contentDisposition: object

parameterPath

parameterPath: string[] = ["options","directoryHttpHeaders","contentDisposition"]

mapper

mapper: object

serializedName

serializedName: string = "x-ms-content-disposition"

type

type: object

name

name: "String" = "String"

Const contentEncoding

contentEncoding: object

parameterPath

parameterPath: string[] = ["options","directoryHttpHeaders","contentEncoding"]

mapper

mapper: object

serializedName

serializedName: string = "x-ms-content-encoding"

type

type: object

name

name: "String" = "String"

Const contentLanguage

contentLanguage: object

parameterPath

parameterPath: string[] = ["options","directoryHttpHeaders","contentLanguage"]

mapper

mapper: object

serializedName

serializedName: string = "x-ms-content-language"

type

type: object

name

name: "String" = "String"

Const contentLength

contentLength: object

parameterPath

parameterPath: string = "contentLength"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "Content-Length"

type

type: object

name

name: "Number" = "Number"

Const contentType

contentType: object

parameterPath

parameterPath: string[] = ["options","directoryHttpHeaders","contentType"]

mapper

mapper: object

serializedName

serializedName: string = "x-ms-content-type"

type

type: object

name

name: "String" = "String"

Const copyActionAbortConstant

copyActionAbortConstant: object

parameterPath

parameterPath: string = "copyActionAbortConstant"

mapper

mapper: object

defaultValue

defaultValue: string = "abort"

isConstant

isConstant: true = true

required

required: true = true

serializedName

serializedName: string = "x-ms-copy-action"

type

type: object

name

name: "String" = "String"

Const copyId

copyId: object

parameterPath

parameterPath: string = "copyId"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "copyid"

type

type: object

name

name: "String" = "String"

Const copySource

copySource: object

parameterPath

parameterPath: string = "copySource"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "x-ms-copy-source"

type

type: object

name

name: "String" = "String"

Const deleteSnapshots

deleteSnapshots: object

parameterPath

parameterPath: string[] = ["options","deleteSnapshots"]

mapper

mapper: object

serializedName

serializedName: string = "x-ms-delete-snapshots"

type

type: object

allowedValues

allowedValues: string[] = ["include","only"]

name

name: "Enum" = "Enum"

Const delimiter

delimiter: object

parameterPath

parameterPath: string = "delimiter"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "delimiter"

type

type: object

name

name: "String" = "String"

Const directoryProperties

directoryProperties: object

parameterPath

parameterPath: string[] = ["options","directoryProperties"]

mapper

mapper: object

serializedName

serializedName: string = "x-ms-properties"

type

type: object

name

name: "String" = "String"

Const duration

duration: object

parameterPath

parameterPath: string[] = ["options","duration"]

mapper

mapper: object

serializedName

serializedName: string = "x-ms-lease-duration"

type

type: object

name

name: "Number" = "Number"

Const encryptionAlgorithm

encryptionAlgorithm: object

parameterPath

parameterPath: string[] = ["options","cpkInfo","encryptionAlgorithm"]

mapper

mapper: object

serializedName

serializedName: string = "x-ms-encryption-algorithm"

type

type: object

allowedValues

allowedValues: string[] = ["AES256"]

name

name: "Enum" = "Enum"

Const encryptionKey

encryptionKey: object

parameterPath

parameterPath: string[] = ["options","cpkInfo","encryptionKey"]

mapper

mapper: object

serializedName

serializedName: string = "x-ms-encryption-key"

type

type: object

name

name: "String" = "String"

Const encryptionKeySha256

encryptionKeySha256: object

parameterPath

parameterPath: string[] = ["options","cpkInfo","encryptionKeySha256"]

mapper

mapper: object

serializedName

serializedName: string = "x-ms-encryption-key-sha256"

type

type: object

name

name: "String" = "String"

Const group

group: object

parameterPath

parameterPath: string[] = ["options","group"]

mapper

mapper: object

serializedName

serializedName: string = "x-ms-group"

type

type: object

name

name: "String" = "String"

Const ifMatch

ifMatch: object

parameterPath

parameterPath: string[] = ["options","modifiedAccessConditions","ifMatch"]

mapper

mapper: object

serializedName

serializedName: string = "If-Match"

type

type: object

name

name: "String" = "String"

Const ifModifiedSince

ifModifiedSince: object

parameterPath

parameterPath: string[] = ["options","modifiedAccessConditions","ifModifiedSince"]

mapper

mapper: object

serializedName

serializedName: string = "If-Modified-Since"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const ifNoneMatch

ifNoneMatch: object

parameterPath

parameterPath: string[] = ["options","modifiedAccessConditions","ifNoneMatch"]

mapper

mapper: object

serializedName

serializedName: string = "If-None-Match"

type

type: object

name

name: "String" = "String"

Const ifSequenceNumberEqualTo

ifSequenceNumberEqualTo: object

parameterPath

parameterPath: string[] = ["options","sequenceNumberAccessConditions","ifSequenceNumberEqualTo"]

mapper

mapper: object

serializedName

serializedName: string = "x-ms-if-sequence-number-eq"

type

type: object

name

name: "Number" = "Number"

Const ifSequenceNumberLessThan

ifSequenceNumberLessThan: object

parameterPath

parameterPath: string[] = ["options","sequenceNumberAccessConditions","ifSequenceNumberLessThan"]

mapper

mapper: object

serializedName

serializedName: string = "x-ms-if-sequence-number-lt"

type

type: object

name

name: "Number" = "Number"

Const ifSequenceNumberLessThanOrEqualTo

ifSequenceNumberLessThanOrEqualTo: object

parameterPath

parameterPath: string[] = ["options","sequenceNumberAccessConditions","ifSequenceNumberLessThanOrEqualTo"]

mapper

mapper: object

serializedName

serializedName: string = "x-ms-if-sequence-number-le"

type

type: object

name

name: "Number" = "Number"

Const ifUnmodifiedSince

ifUnmodifiedSince: object

parameterPath

parameterPath: string[] = ["options","modifiedAccessConditions","ifUnmodifiedSince"]

mapper

mapper: object

serializedName

serializedName: string = "If-Unmodified-Since"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const include0

include0: object

parameterPath

parameterPath: string[] = ["options","include"]

mapper

mapper: object

serializedName

serializedName: string = "include"

type

type: object

allowedValues

allowedValues: string[] = ["metadata"]

name

name: "Enum" = "Enum"

Const include1

include1: object

collectionFormat

collectionFormat: Csv = msRest.QueryCollectionFormat.Csv

parameterPath

parameterPath: string[] = ["options","include"]

mapper

mapper: object

serializedName

serializedName: string = "include"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

allowedValues

allowedValues: string[] = ["copy","deleted","metadata","snapshots","uncommittedblobs"]

name

name: "Enum" = "Enum"

Const leaseId0

leaseId0: object

parameterPath

parameterPath: string[] = ["options","leaseAccessConditions","leaseId"]

mapper

mapper: object

serializedName

serializedName: string = "x-ms-lease-id"

type

type: object

name

name: "String" = "String"

Const leaseId1

leaseId1: object

parameterPath

parameterPath: string = "leaseId"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "x-ms-lease-id"

type

type: object

name

name: "String" = "String"

Const listType

listType: object

parameterPath

parameterPath: string = "listType"

mapper

mapper: object

defaultValue

defaultValue: string = "committed"

required

required: true = true

serializedName

serializedName: string = "blocklisttype"

type

type: object

allowedValues

allowedValues: string[] = ["committed","uncommitted","all"]

name

name: "Enum" = "Enum"

Const marker0

marker0: object

parameterPath

parameterPath: string[] = ["options","marker"]

mapper

mapper: object

serializedName

serializedName: string = "marker"

type

type: object

name

name: "String" = "String"

Const marker1

marker1: object

parameterPath

parameterPath: string[] = ["options","marker"]

mapper

mapper: object

serializedName

serializedName: string = "continuation"

type

type: object

name

name: "String" = "String"

Const maxSize

maxSize: object

parameterPath

parameterPath: string[] = ["options","appendPositionAccessConditions","maxSize"]

mapper

mapper: object

serializedName

serializedName: string = "x-ms-blob-condition-maxsize"

type

type: object

name

name: "Number" = "Number"

Const maxresults

maxresults: object

parameterPath

parameterPath: string[] = ["options","maxresults"]

mapper

mapper: object

serializedName

serializedName: string = "maxresults"

constraints

constraints: object

InclusiveMinimum

InclusiveMinimum: number = 1

type

type: object

name

name: "Number" = "Number"

Const metadata

metadata: object

parameterPath

parameterPath: string[] = ["options","metadata"]

mapper

mapper: object

headerCollectionPrefix

headerCollectionPrefix: string = "x-ms-meta-"

serializedName

serializedName: string = "x-ms-meta"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "String" = "String"

Const multipartContentType

multipartContentType: object

parameterPath

parameterPath: string = "multipartContentType"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "Content-Type"

type

type: object

name

name: "String" = "String"

Const owner

owner: object

parameterPath

parameterPath: string[] = ["options","owner"]

mapper

mapper: object

serializedName

serializedName: string = "x-ms-owner"

type

type: object

name

name: "String" = "String"

Const pageWrite0

pageWrite0: object

parameterPath

parameterPath: string = "pageWrite"

mapper

mapper: object

defaultValue

defaultValue: string = "update"

isConstant

isConstant: true = true

required

required: true = true

serializedName

serializedName: string = "x-ms-page-write"

type

type: object

name

name: "String" = "String"

Const pageWrite1

pageWrite1: object

parameterPath

parameterPath: string = "pageWrite"

mapper

mapper: object

defaultValue

defaultValue: string = "clear"

isConstant

isConstant: true = true

required

required: true = true

serializedName

serializedName: string = "x-ms-page-write"

type

type: object

name

name: "String" = "String"

Const pathRenameMode

pathRenameMode: object

parameterPath

parameterPath: string = "pathRenameMode"

mapper

mapper: object

serializedName

serializedName: string = "mode"

type

type: object

allowedValues

allowedValues: string[] = ["legacy","posix"]

name

name: "Enum" = "Enum"

Const posixAcl

posixAcl: object

parameterPath

parameterPath: string[] = ["options","posixAcl"]

mapper

mapper: object

serializedName

serializedName: string = "x-ms-acl"

type

type: object

name

name: "String" = "String"

Const posixPermissions

posixPermissions: object

parameterPath

parameterPath: string[] = ["options","posixPermissions"]

mapper

mapper: object

serializedName

serializedName: string = "x-ms-permissions"

type

type: object

name

name: "String" = "String"

Const posixUmask

posixUmask: object

parameterPath

parameterPath: string[] = ["options","posixUmask"]

mapper

mapper: object

serializedName

serializedName: string = "x-ms-umask"

type

type: object

name

name: "String" = "String"

Const prefix

prefix: object

parameterPath

parameterPath: string[] = ["options","prefix"]

mapper

mapper: object

serializedName

serializedName: string = "prefix"

type

type: object

name

name: "String" = "String"

Const prevsnapshot

prevsnapshot: object

parameterPath

parameterPath: string[] = ["options","prevsnapshot"]

mapper

mapper: object

serializedName

serializedName: string = "prevsnapshot"

type

type: object

name

name: "String" = "String"

Const proposedLeaseId0

proposedLeaseId0: object

parameterPath

parameterPath: string[] = ["options","proposedLeaseId"]

mapper

mapper: object

serializedName

serializedName: string = "x-ms-proposed-lease-id"

type

type: object

name

name: "String" = "String"

Const proposedLeaseId1

proposedLeaseId1: object

parameterPath

parameterPath: string = "proposedLeaseId"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "x-ms-proposed-lease-id"

type

type: object

name

name: "String" = "String"

Const range0

range0: object

parameterPath

parameterPath: string[] = ["options","range"]

mapper

mapper: object

serializedName

serializedName: string = "x-ms-range"

type

type: object

name

name: "String" = "String"

Const range1

range1: object

parameterPath

parameterPath: string = "range"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "x-ms-range"

type

type: object

name

name: "String" = "String"

Const rangeGetContentCRC64

rangeGetContentCRC64: object

parameterPath

parameterPath: string[] = ["options","rangeGetContentCRC64"]

mapper

mapper: object

serializedName

serializedName: string = "x-ms-range-get-content-crc64"

type

type: object

name

name: "Boolean" = "Boolean"

Const rangeGetContentMD5

rangeGetContentMD5: object

parameterPath

parameterPath: string[] = ["options","rangeGetContentMD5"]

mapper

mapper: object

serializedName

serializedName: string = "x-ms-range-get-content-md5"

type

type: object

name

name: "Boolean" = "Boolean"

Const recursiveDirectoryDelete

recursiveDirectoryDelete: object

parameterPath

parameterPath: string = "recursiveDirectoryDelete"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "recursive"

type

type: object

name

name: "Boolean" = "Boolean"

Const rehydratePriority

rehydratePriority: object

parameterPath

parameterPath: string[] = ["options","rehydratePriority"]

mapper

mapper: object

serializedName

serializedName: string = "x-ms-rehydrate-priority"

type

type: object

name

name: "String" = "String"

Const renameSource

renameSource: object

parameterPath

parameterPath: string = "renameSource"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "x-ms-rename-source"

type

type: object

name

name: "String" = "String"

Const requestId

requestId: object

parameterPath

parameterPath: string[] = ["options","requestId"]

mapper

mapper: object

serializedName

serializedName: string = "x-ms-client-request-id"

type

type: object

name

name: "String" = "String"

Const resource

resource: object

parameterPath

parameterPath: string = "resource"

mapper

mapper: object

defaultValue

defaultValue: string = "directory"

isConstant

isConstant: true = true

required

required: true = true

serializedName

serializedName: string = "resource"

type

type: object

name

name: "String" = "String"

Const restype0

restype0: object

parameterPath

parameterPath: string = "restype"

mapper

mapper: object

defaultValue

defaultValue: string = "service"

isConstant

isConstant: true = true

required

required: true = true

serializedName

serializedName: string = "restype"

type

type: object

name

name: "String" = "String"

Const restype1

restype1: object

parameterPath

parameterPath: string = "restype"

mapper

mapper: object

defaultValue

defaultValue: string = "account"

isConstant

isConstant: true = true

required

required: true = true

serializedName

serializedName: string = "restype"

type

type: object

name

name: "String" = "String"

Const restype2

restype2: object

parameterPath

parameterPath: string = "restype"

mapper

mapper: object

defaultValue

defaultValue: string = "container"

isConstant

isConstant: true = true

required

required: true = true

serializedName

serializedName: string = "restype"

type

type: object

name

name: "String" = "String"

Const sequenceNumberAction

sequenceNumberAction: object

parameterPath

parameterPath: string = "sequenceNumberAction"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "x-ms-sequence-number-action"

type

type: object

allowedValues

allowedValues: string[] = ["max","update","increment"]

name

name: "Enum" = "Enum"

Const snapshot

snapshot: object

parameterPath

parameterPath: string[] = ["options","snapshot"]

mapper

mapper: object

serializedName

serializedName: string = "snapshot"

type

type: object

name

name: "String" = "String"

Const sourceContentCrc64

sourceContentCrc64: object

parameterPath

parameterPath: string[] = ["options","sourceContentCrc64"]

mapper

mapper: object

serializedName

serializedName: string = "x-ms-source-content-crc64"

type

type: object

name

name: "ByteArray" = "ByteArray"

Const sourceContentMD5

sourceContentMD5: object

parameterPath

parameterPath: string[] = ["options","sourceContentMD5"]

mapper

mapper: object

serializedName

serializedName: string = "x-ms-source-content-md5"

type

type: object

name

name: "ByteArray" = "ByteArray"

Const sourceIfMatch

sourceIfMatch: object

parameterPath

parameterPath: string[] = ["options","sourceModifiedAccessConditions","sourceIfMatch"]

mapper

mapper: object

serializedName

serializedName: string = "x-ms-source-if-match"

type

type: object

name

name: "String" = "String"

Const sourceIfModifiedSince

sourceIfModifiedSince: object

parameterPath

parameterPath: string[] = ["options","sourceModifiedAccessConditions","sourceIfModifiedSince"]

mapper

mapper: object

serializedName

serializedName: string = "x-ms-source-if-modified-since"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const sourceIfNoneMatch

sourceIfNoneMatch: object

parameterPath

parameterPath: string[] = ["options","sourceModifiedAccessConditions","sourceIfNoneMatch"]

mapper

mapper: object

serializedName

serializedName: string = "x-ms-source-if-none-match"

type

type: object

name

name: "String" = "String"

Const sourceIfUnmodifiedSince

sourceIfUnmodifiedSince: object

parameterPath

parameterPath: string[] = ["options","sourceModifiedAccessConditions","sourceIfUnmodifiedSince"]

mapper

mapper: object

serializedName

serializedName: string = "x-ms-source-if-unmodified-since"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const sourceLeaseId

sourceLeaseId: object

parameterPath

parameterPath: string[] = ["options","sourceLeaseId"]

mapper

mapper: object

serializedName

serializedName: string = "x-ms-source-lease-id"

type

type: object

name

name: "String" = "String"

Const sourceRange0

sourceRange0: object

parameterPath

parameterPath: string = "sourceRange"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "x-ms-source-range"

type

type: object

name

name: "String" = "String"

Const sourceRange1

sourceRange1: object

parameterPath

parameterPath: string[] = ["options","sourceRange"]

mapper

mapper: object

serializedName

serializedName: string = "x-ms-source-range"

type

type: object

name

name: "String" = "String"

Const sourceUrl

sourceUrl: object

parameterPath

parameterPath: string = "sourceUrl"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "x-ms-copy-source"

type

type: object

name

name: "String" = "String"

Const tier0

tier0: object

parameterPath

parameterPath: string[] = ["options","tier"]

mapper

mapper: object

serializedName

serializedName: string = "x-ms-access-tier"

type

type: object

name

name: "String" = "String"

Const tier1

tier1: object

parameterPath

parameterPath: string = "tier"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "x-ms-access-tier"

type

type: object

name

name: "String" = "String"

Const timeout

timeout: object

parameterPath

parameterPath: string[] = ["options","timeout"]

mapper

mapper: object

serializedName

serializedName: string = "timeout"

constraints

constraints: object

InclusiveMinimum

InclusiveMinimum: number = 0

type

type: object

name

name: "Number" = "Number"

Const transactionalContentCrc64

transactionalContentCrc64: object

parameterPath

parameterPath: string[] = ["options","transactionalContentCrc64"]

mapper

mapper: object

serializedName

serializedName: string = "x-ms-content-crc64"

type

type: object

name

name: "ByteArray" = "ByteArray"

Const transactionalContentMD5

transactionalContentMD5: object

parameterPath

parameterPath: string[] = ["options","transactionalContentMD5"]

mapper

mapper: object

serializedName

serializedName: string = "Content-MD5"

type

type: object

name

name: "ByteArray" = "ByteArray"

Const upn

upn: object

parameterPath

parameterPath: string[] = ["options","upn"]

mapper

mapper: object

serializedName

serializedName: string = "upn"

type

type: object

name

name: "Boolean" = "Boolean"

Const url

url: object

parameterPath

parameterPath: string = "url"

skipEncoding

skipEncoding: true = true

mapper

mapper: object

defaultValue

defaultValue: string = ""

required

required: true = true

serializedName

serializedName: string = "url"

type

type: object

name

name: "String" = "String"

Const version

version: object

parameterPath

parameterPath: string = "version"

mapper

mapper: object

defaultValue

defaultValue: string = "2019-02-02"

isConstant

isConstant: true = true

required

required: true = true

serializedName

serializedName: string = "x-ms-version"

type

type: object

name

name: "String" = "String"

Const xMsRequiresSync

xMsRequiresSync: object

parameterPath

parameterPath: string = "xMsRequiresSync"

mapper

mapper: object

defaultValue

defaultValue: string = "true"

isConstant

isConstant: true = true

required

required: true = true

serializedName

serializedName: string = "x-ms-requires-sync"

type

type: object

name

name: "String" = "String"

Generated using TypeDoc